@makerx/ts-toolkit

A simple cli utility to assist in standardising several boilerplate files across our typescript repositories.

The files it concerns itself with are:

• .editorconfig
• .eslintignore
• .eslintrc
• .gitattributes
• .gitignore
• .prettierrc.js
• .prettierignore
• tsconfig.json

The cli will output a starter version of these files which can then be extended to suit an individual project's needs. Where possible these files extend a base configuration file in a separate package (eg @makerx/eslint-config or @makerx/prettier-config). These packages may evolve over time and the latest can be obtained via npm (eg. npm i -D @makerx/eslint-config@latest)

It is recommended you commit all pending changes before running the cli so that you can compare and / or reset changes

Usage

npx @makerx/ts-toolkit init --existing-file-behaviour <sample|overwrite|skip> --platform <node> --no-scripts

Options

Existing file behaviour (--existing-file-behaviour or -efb)

This option dictates how existing files are handled. The default value is sample

• sample - If a file already exists, write an additional .sample file
• overwrite - If a file already exists, overwrite it
• skip - If a file already exists, skip it

Platform (--platform or -p)

Not used yet, but will be used to output platform specific files. The default value is node

No Scripts (--no-scripts or -ns)

If provided, cli will skip adding any scripts to your package.json

No Install (--no-install or -ni)

After adding new packages to your package.json, Toolkit will run npm install to install this packages. Passing in this parameter will disable that behaviour.

copy-package-json

The ts-toolkit also includes a utility for copying your package.json file into a dist directory without superfluous sections like devDependencies and scripts. It will also replace key sections based on the arguments passed in

The basic version takes several arguments which detail explicit values for what is to be replaced

# e.g. with defaults:
tstk copy-package-json
# or with all args:
tstk copy-package-json --input-folder ./subfolder --output-folder ./dist/subfolder --main 'app.js' --types 'app.d.ts' --custom-sections extraSection1 extraSection2

An alternative option has been added in v4 which takes its arguments from a configuration file. ts-toolkit uses cosmiconfig so any of the compatible formats of cosmiconfig are supported. The recommended approach is to use a typescript file though as it will give you intellisense

This feature is very experimental at this stage and may not work as expected for atypical scenarios (ie. ones which do not match this repo)

/* Sample .tstoolkitrc.ts */
import {TsToolkitConfig} from "@makerx/ts-toolkit";

const config: TsToolkitConfig = {
  packageConfig: {
    srcDir: 'src',
    outDir: 'dist',
    moduleType: 'module',
    main: 'index.ts',
    bin: {
      '@makerx/ts-toolkit': 'bin/run-cli.ts',
      tstk: 'bin/run-cli.ts',
    }
  }
}
export default config

File paths used in this config file should point to the typescript file relative to the source directory. The tool will translate this to relevant js/mjs/d.ts paths in the out directory.

Sub-Packages

@makerx/eslint-config

A set of default eslint plugins and rules

@makerx/prettier-config

A default prettier configuration

@makerx/ts-config

A default tsconfig configuration

Contributing

Releasing

Releases are set up to push a new version of each package when the version number is changed. If you don't change the version number, that package will not be re-published