Liking cljdoc? Tell your friends :D

automaton-build.code.artifacts

A proxy to library for building artifacts in Clojure projects.

A proxy to library for building artifacts in Clojure projects.
raw docstring

automaton-build.code.cljs

cljs compiler toolings. Use shadow on npx.

Proxy to npx

cljs compiler toolings. Use shadow on npx.

Proxy to [npx](https://shadow-cljs.github.io/docs/UsersGuide.html#_command_line)
raw docstring

automaton-build.code.forbidden-words

Search for some (forbidden) keywords in the project code.

Search for some (forbidden) keywords in the project code.
raw docstring

automaton-build.code.formatter

Format code to apply rules in zprintrc.

Proxy to zprint

Format code to apply rules in `zprintrc`.

Proxy to [zprint](https://github.com/kkinnear/zprint)
raw docstring

automaton-build.code.lint

Lint the application.

Proxy to clj-kondo

Lint the application.

Proxy to [clj-kondo](https://github.com/clj-kondo/clj-kondo?tab=readme-ov-file#usage) 
raw docstring

automaton-build.data.keyword

Utility functions for keywords.

Utility functions for keywords.
raw docstring

automaton-build.data.schema

Validate the data against the schema.

Proxy to malli.

Validate the data against the schema.

Proxy to [malli](https://github.com/metosin/malli).
raw docstring

automaton-build.doc.mermaid-bb

Create mermaid images.

Proxy to mermaid cli

Create mermaid images.

Proxy to [mermaid cli](https://www.npmjs.com/package/@mermaid-js/mermaid-cli)
raw docstring

automaton-build.echo.actions

Echoing in terminal for long living and possibly parrallel actions (like REPL and so on.).

Each line is prefixed with the name of the concerned action.

Echoing in terminal for long living and possibly parrallel actions (like REPL and so on.).

Each line is prefixed with the name of the concerned action.
raw docstring

automaton-build.echo.common

Common functions for echoing. Don't use this namespace but one of the implementation of echoing, like headers or actions.

Common functions for echoing. Don't use this namespace but one of the implementation of echoing, like headers or actions.
raw docstring

automaton-build.echo.headers

Prints text with headers on the terminal.

Each content is modified to wrap the width of the terminal, and is modified to have a left margin.

Prints text with headers on the terminal.

Each content is modified to wrap the `width` of the terminal, and is modified to have a left margin.
raw docstring

automaton-build.fe.css

Load the file css.

Proxy to tailwindcss.

Load the file css.

Proxy to [tailwindcss](https://tailwindcss.com/docs/installation).
raw docstring

automaton-build.html.redirect

Creates an html page to redirect to another page.

Creates an html page to redirect to another page.
raw docstring

automaton-build.monorepo.apps

A project map for a monorepo with subprojects.

A project map for a monorepo with subprojects.
raw docstring

automaton-build.os.cli-opts

Parse cli options.

Proxy to tools.cli

Parse cli options.

Proxy to [tools.cli](https://github.com/clojure/tools.cli)
raw docstring

automaton-build.os.filename

Manipulate file names (is not influenced at all by your local configuration).

Manipulate file names (is not influenced at all by your local configuration).
raw docstring

automaton-build.os.json-bb

Everything about json manipulation

Everything about json manipulation
raw docstring

automaton-build.os.user

Return system wide user informations.

Return system wide user informations.
raw docstring

automaton-build.os.version

Version of the current codebase

  • Version is based on a root project file named version.edn. Strengths:
  • One source of truth for version.
  • Change of version in a PR is more straightforward to notice
  • Flexibility (We don't decide on versioning strategy, we just have file that is point of reference to what version you are on.) Constraints:
  • Keeping up with updates for version files (although with automated tooling we have, it is not that big of a deal currently)

Previous design:

  • major version has to be changed in the major-version in build_config.edn (many sources of truth and build_config shouldn't be a place that is used as variable that change often)
  • counting commits from a branch to base a minor version on it (Many edgecases where commits don't match the version, initial commits, PRs having more than one commit...)
Version of the current codebase

* Version is based on a root project file named `version.edn`.
Strengths:
* One source of truth for version.
* Change of version in a PR is more straightforward to notice
* Flexibility (We don't decide on versioning strategy, we just have file that is point of reference to what version you are on.)
Constraints:
 * Keeping up with updates for version files (although with automated tooling we have, it is not that big of a deal currently)

Previous design:
* major version has to be changed in the major-version in `build_config.edn` (many sources of truth and build_config shouldn't be a place that is used as variable that change often)
* counting commits from a branch to base a minor version on it (Many edgecases where commits don't match the version, initial commits, PRs having more than one commit...)
raw docstring

automaton-build.project.config

Loads project configuration file.

Loads `project` configuration file.
raw docstring

automaton-build.project.configuration

Configuration parameters, stored in configuration file. This namespace is the entry point to call conf

Configuration parameters, stored in configuration file.
This namespace is the entry point to call conf
raw docstring

automaton-build.project.impl.clever-cloud-deploy

Code here is regarding all interactions with clever cloud. Design decision: Interaction with clever cloud is by using git.

Alternatively it could be done by using clever CLI, but currently we don't need any features that can't be done by simply manipulating the repository in the git. Which is a simpler option in terms of complexity (no need for API to check), while still being flexible (a lot of options to manipulate in git). Additionally this doesn't require to install the clever cloud cli.

Code here is regarding all interactions with clever cloud.
Design decision:
Interaction with clever cloud is by using git.

Alternatively it could be done by using clever CLI, but currently we don't need any features that can't be done by simply manipulating the repository in the git. Which is a simpler option in terms of complexity (no need for API to check), while still being flexible (a lot of options to manipulate in git). Additionally this doesn't require to install the clever cloud cli.
raw docstring

automaton-build.project.impl.config-files

Simple configuration based on files Data can be set in java property heph-conf, if more files are needed you can pass them separated by ,

Simple configuration based on files
Data can be set in java property `heph-conf`, if more files are needed you can pass them separated by `,`
raw docstring

automaton-build.project.map

The project map gathers all useful informations for a project

The project map gathers all useful informations for a project
raw docstring

automaton-build.project.versioning

Code related to app versioning, holds current strategy for versioning

Code related to app versioning, holds current strategy for versioning
raw docstring

automaton-build.tasks.2

Workflow 2 is starting a local development environment

Workflow 2 is starting a local development environment
raw docstring

automaton-build.tasks.common

All common workflow features.

All common workflow features.
raw docstring

automaton-build.tasks.docs

Publish documentation.

Proxy to codox.

Publish documentation.

Proxy to [codox](https://github.com/weavejester/codox?tab=readme-ov-file).
raw docstring

automaton-build.tasks.impl.commit

In a workflow, commit.

In a workflow, commit.
raw docstring

automaton-build.tasks.impl.headers.deps

Load deps edn with headers logs.

Load deps edn with headers logs.
raw docstring

automaton-build.tasks.impl.headers.shadow

Echo error message for shadow file manipulation.

Echo error message for shadow file manipulation.
raw docstring

automaton-build.tasks.impl.linter

In a workflow, lint a project.

In a workflow, lint a project.
raw docstring

automaton-build.tasks.impl.report-aliases

Report aliases inconsistency:

  • One ns with more than one alias,
  • One alias assigned to more than one namespace..
Report aliases inconsistency:
* One `ns` with more than one alias,
* One `alias` assigned to more than one namespace..
raw docstring

automaton-build.tasks.impl.reports

Common reporting features.

Common reporting features.
raw docstring

automaton-build.tasks.impl.reports-fw

Scan code files for forbidden words.

The forbidden words ca be setup in the project.edn under the [:code :forbidden-words]

It will report whatever word is set this project.edn, except infiles which first line is: #":heph-ignore\s*{[^}]*:forbidden-words".

that will ignore forbidden-words.

Scan code files for forbidden words.

The forbidden words ca be setup in the `project.edn` under the `[:code :forbidden-words]`

It will report whatever word is set this project.edn, except infiles which first line is:
#":heph-ignore\s*\{[^\}]*:forbidden-words".

that will ignore `forbidden-words`.
raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close