Skip to main content

Getting Started

Installation​

npx @rtorcato/js-tooling setup

What it looks like​

Terminal
$ npx @rtorcato/js-tooling setup

🛠️  Welcome to JS Tooling Setup!

Setting up tooling in: /home/user/my-lib

? 📦 What is your project name? my-lib
? 🏗️  What type of project are you building? 📚 Library/Package
? 📘 Do you want to use TypeScript? Yes
? ⚙️  Which TypeScript configuration? 🔧 Base (General purpose)
? 🔍 Which linting/formatting tool? ⚡ Biome (Fast, all-in-one)
? 🧪 Which testing framework? ⚡ Vitest (Fast, Vite-powered)
? 🪝 Set up Git hooks (Husky + lint-staged)? Yes
? 📝 Set up conventional commit linting? Yes
? 🚀 Set up semantic release for automated versioning? Yes
? 🛡️  Include security automation (Dependabot + CodeQL)? Yes
? 📦 Which bundler/build tool? 📦 tsup (TypeScript packages)

📝 Generating configuration files...

✅ Setup completed successfully!

📋 Next Steps:

  1. 🔧 Customize your tsconfig.json as needed
  2. 🔍 Run linting with: pnpm biome check .
  3. 🧪 Run tests with: pnpm vitest
  4. 🪝 Commit your changes to test the git hooks
  5. 📖 Check the generated README.md for more details

Setup wizard​

Running setup (or its alias init) launches an interactive wizard:

PromptOptions
Project namedefaults to directory name
Project typelibrary, web-app, node-api, nextjs-app, react-app
TypeScript?yes/no
TS config variantbase, react, next, node, express (context-filtered)
Linting/formatting toolbiome (recommended), eslint, both, none
ESLint config (if ESLint)base or nextjs
Testing frameworkvitest (recommended), jest, playwright, none
Test environment (if Jest)node, browser, both
Git hooks (Husky + lint-staged)?yes/no
Conventional commit linting?yes/no (if git hooks enabled)
Semantic release?yes/no (library projects only)
Security automation (Dependabot + CodeQL)?yes/no
Bundlertsup, esbuild, vite (web apps), none

A universal baseline (.editorconfig, .nvmrc, engines.node, knip.json) is scaffolded automatically — no prompt — because these are safe defaults for every project.

Files generated​

  • package.json — merged with chosen devDependencies, scripts, and engines.node
  • .editorconfig, .nvmrc, knip.json — universal baseline
  • tsconfig.json — extends the matching preset
  • biome.json / eslint.config.js + prettier.config.js — based on linting choice
  • vitest.config.js / jest.config.js — testing config
  • .husky/pre-commit, commitlint.config.js — if git hooks chosen
  • release.config.js — if semantic release chosen
  • .github/workflows/ci.yml — CI workflow
  • .github/dependabot.yml, .github/workflows/codeql.yml — if security automation chosen
  • README.md — project README scaffold
  • reset.d.ts — ts-reset type augmentation (if TypeScript)

Existing projects: doctor + fix​

For repos that already exist, don't rerun setup (it's a fresh-project wizard and would clobber your configs). Use doctor to find drift, then fix to apply scaffolders incrementally:

npx @rtorcato/js-tooling doctor          # see what's missing or drifted
npx @rtorcato/js-tooling fix             # walk every finding, prompting per item
npx @rtorcato/js-tooling fix dependabot  # or apply just one

fix defaults to No when overwriting existing files — your customisations are preserved unless you explicitly opt in (or pass --yes). See CLI reference for full details.

Using specific configs without the wizard​

If you only need one config file, use copy:

npx @rtorcato/js-tooling copy biome     # → biome.json
npx @rtorcato/js-tooling copy tsconfig  # → tsconfig.json

Or import configs directly in your own files:

import '@rtorcato/js-tooling/typescript/base'

CI/CD secrets​

For automated publishing via Semantic Release, add these to your GitHub repository secrets:

  1. NPM_TOKEN — npm authentication token
  2. GITHUB_TOKEN — automatically provided by GitHub Actions

Settings → Secrets and variables → Actions