Code Ready

Command-line tool and package generator for NodeJS. It automates the installation and configuration of essential development tools, including linters (ESLint), code formatters (Prettier), testing libraries and frameworks (Jest), and a build tools (tsup), offering support for both JavaScript and TypeScript projects.

It is been deployed by the very first release using:

| DEVELOPMENT BLOCK | SUPPORTEDS | DEFAULT | | :---------------- | :--------------------------------------- | :--------- | | Code | Javascript (ESM / CommonJS) + Typescript | Javascript | | Unit Test | Jest | Jest | | SVC Repository | Git + Github | Git | | Lint | ESLint | | | Format | Prettier | | | BUILD | tsup + tsc? | tsup |

Requirements

• NodeJS: https://nodejs.org/
• npm: https://www.npmjs.com/
• Npmjs access token.
• Github secret defined.

Npmjs & Github Authorization

It must be created a new Access Token into your Account section in npmjs.com.

Manage your authentication tokens for your npm account

Store it in Github browsing to the repository and click on 'Settings > Secrets & Variables > Actions > Repository Secrets ' and click on 'New repository secret' and follow the instructions.

Using secrets in GitHub Actions

Token Name

The token must be called 'npm_token'

Whether the token is not called this way or is not defined, the workflow will fail and will break abd finish the Github Action with an error state.

Tools

• Linter: ESLint

  Manage lint rules for Typescript, Javascript, JSON and Github Markdown: eslint

  Typescript support: typescript-eslint

  Javascript support: @eslint/js

  JSON support: @eslint/json+

  Markdown support (for Github Markdown): @eslint/markdown

• Formatter: Prettier

  Manage format rules: prettier

  Deactivate conflictive and not compatible rules between ESLint and Prettier: eslint-config-prettier

  Running Prettier with ESLint: eslint-plugin-prettier

• Unit Test: Jest

  Creating and Running the unit tests: jest

• Bundler: Tsup

  Bundle Typescript easily: tsup

Install

npm i [package] [-D] [-S]
npx codeready

It will creates the files and folders for ready-to-start development.