create-checks 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 cadienvan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,307 @@
+# create-checks
+
+A zero-config scaffolding CLI that wires **ESLint + Prettier** into any Node.js project in one command.
+
+```sh
+npm create @jeportie/checks
+```
+
+---
+
+## What it does
+
+Running `npm create @jeportie/checks` inside an existing project will:
+
+1. **Install** ESLint, Prettier, and their plugins as dev dependencies
+2. **Copy** `eslint.config.js` and `prettier.config.js` into your project root
+3. **Inject** three scripts into your `package.json`:
+   - `lint` → `eslint .`
+   - `format` → `prettier . --write`
+   - `typecheck` → `tsc --noEmit`
+
+Everything runs in your project — nothing is installed globally.
+
+---
+
+## Quick start
+
+```sh
+# Inside your existing project
+npm create @jeportie/checks
+
+# Then use the injected scripts
+npm run lint
+npm run format
+npm run typecheck
+```
+
+---
+
+## How it works internally
+
+```
+npm create @jeportie/checks
+        │
+        └─▶ npm downloads the create-checks package
+            └─▶ node runs ./src/index.js  (registered via "bin" in package.json)
+                │
+                ├─ 1. npm install -D eslint prettier ...   (in YOUR project's CWD)
+                ├─ 2. copy src/templates/eslint.config.js  → YOUR project/eslint.config.js
+                ├─ 3. copy src/templates/prettier.config.js → YOUR project/prettier.config.js
+                └─ 4. read YOUR project/package.json → inject scripts → write it back
+```
+
+### Template path resolution
+
+Inside `src/index.js`:
+
+```js
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const cwd = process.cwd();
+```
+
+- `__dirname` always points to `create-checks/src/` — the CLI's own files, wherever npm installed them
+- `cwd` is **your** project's directory — where files get copied and `package.json` gets updated
+
+This separation is what lets a `create-*` tool safely write into an unrelated target directory.
+
+### How `bin` mapping works in npm
+
+```json
+"bin": {
+  "create-checks": "./src/index.js"
+}
+```
+
+When npm installs a package that has a `bin` field, it creates a symlink in `node_modules/.bin/`. When you run `npm create foo`, npm translates that into `npm exec create-foo` and executes the registered binary. The `#!/usr/bin/env node` shebang on line 1 of `src/index.js` tells the OS to run it with Node.
+
+---
+
+## What gets installed in your project
+
+| Package                             | Purpose                                           |
+| ----------------------------------- | ------------------------------------------------- |
+| `eslint`                            | JavaScript/TypeScript linter                      |
+| `prettier`                          | Opinionated code formatter                        |
+| `eslint-config-prettier`            | Disables ESLint rules that conflict with Prettier |
+| `typescript-eslint`                 | TypeScript parser and rules for ESLint            |
+| `@stylistic/eslint-plugin`          | Code style rules (quotes, spacing, etc.)          |
+| `eslint-plugin-import`              | Import order and resolution rules                 |
+| `eslint-import-resolver-typescript` | Resolves TypeScript paths in import plugin        |
+
+---
+
+## What the templates configure
+
+### `eslint.config.js`
+
+Uses ESLint's flat config format (ESLint 9+). Includes:
+
+- `@eslint/js` recommended rules
+- Full TypeScript type-checked rules via `typescript-eslint`
+- Stylistic rules (single quotes, spaced comments)
+- Import ordering and cycle detection
+- Prettier compatibility (must be last)
+- Test file overrides (relaxed rules in `*.test.*`)
+
+### `prettier.config.js`
+
+Standard Prettier settings:
+
+- Single quotes, trailing commas, 80-char print width
+- No semicolons in prose, arrow parens always
+
+---
+
+## Next steps — optional tooling
+
+After running `create-checks`, here are recommended tools to layer on top:
+
+### Husky — git hooks
+
+Runs linting/tests automatically before every commit.
+
+```sh
+npm install -D husky
+npx husky init
+```
+
+Add to `.husky/pre-commit`:
+
+```sh
+npx lint-staged
+```
+
+### lint-staged — only lint changed files
+
+Prevents the pre-commit hook from linting your entire codebase.
+
+```sh
+npm install -D lint-staged
+```
+
+Add to `package.json`:
+
+```json
+"lint-staged": {
+  "*.{js,ts}": ["eslint --fix", "prettier --write"],
+  "*.{json,yml,md}": ["prettier --write --ignore-unknown"]
+}
+```
+
+### Commitlint — enforce Conventional Commits
+
+Ensures commit messages follow the `feat:`, `fix:`, `chore:` convention required by semantic-release.
+
+```sh
+npm install -D @commitlint/cli @commitlint/config-conventional
+echo "export default { extends: ['@commitlint/config-conventional'] };" > commitlint.config.js
+```
+
+Add to `.husky/commit-msg`:
+
+```sh
+npx --no -- commitlint --edit $1
+```
+
+### Secretlint — prevent secret leaks
+
+Scans your files for accidentally committed API keys, tokens, and passwords.
+
+```sh
+npm install -D secretlint @secretlint/secretlint-rule-preset-recommend
+```
+
+Add a `.secretlintrc.json`:
+
+```json
+{
+  "rules": [{ "id": "@secretlint/secretlint-rule-preset-recommend" }]
+}
+```
+
+Add to `package.json` scripts:
+
+```json
+"secretlint": "secretlint ./src --maskSecrets"
+```
+
+### CSpell — spell checking
+
+Catches typos in source code, comments, and docs.
+
+```sh
+npm install -D cspell
+```
+
+Add to `package.json` scripts:
+
+```json
+"spellcheck": "cspell --no-progress \"./**/*.{js,ts,md,json}\""
+```
+
+### Semantic Release — automated versioning and publishing
+
+Reads your Conventional Commits and automatically bumps the version, generates a changelog, and publishes to npm.
+
+See [How to release](#how-to-release) below.
+
+---
+
+## How to release
+
+This repo is pre-configured with [semantic-release](https://semantic-release.gitbook.io/semantic-release/).
+
+### One-time setup
+
+1. Create an **npm access token** at [npmjs.com → Access Tokens](https://www.npmjs.com/settings/~/tokens) (type: **Automation**)
+2. Add it as a secret named `NPM_TOKEN` in your GitHub repo under **Settings → Secrets → Actions**
+3. `GITHUB_TOKEN` is provided automatically — no action needed
+
+### Release flow
+
+```
+git commit -m "feat: add support for --skip-install flag"
+git push origin main
+        │
+        └─▶ GitHub Actions: semantic-release.yml
+             ├─ Analyzes commits since last tag
+             │   feat  → minor bump  (0.1.0 → 0.2.0)
+             │   fix   → patch bump  (0.1.0 → 0.1.1)
+             │   feat! → major bump  (0.1.0 → 1.0.0)
+             ├─ Generates release notes
+             ├─ Publishes to npm registry
+             └─ Creates a GitHub Release + git tag (v0.2.0)
+```
+
+**Never bump the version in `package.json` manually** — semantic-release owns that. The placeholder `"0.0.0-semantically-released"` is intentional and gets replaced at publish time.
+
+### Commit message format
+
+```
+<type>(<scope>): <description>
+
+feat: add --dry-run flag
+fix: resolve template path on Windows
+docs: update README with next steps
+chore: upgrade eslint to v9
+```
+
+---
+
+## Development
+
+### Requirements
+
+- Node.js 20+ (see `.nvmrc`)
+- npm
+
+### Setup
+
+```sh
+git clone https://github.com/jeportie/create-checks.git
+cd create-checks
+npm install
+```
+
+### Run tests
+
+```sh
+npm test                  # all tests
+npm run test:integration  # integration tests only
+npm run test:coverage     # with coverage report
+```
+
+### Test a local build
+
+```sh
+mkdir /tmp/my-test-project
+cd /tmp/my-test-project
+npm init -y
+node /path/to/create-checks/src/index.js
+```
+
+### Project structure
+
+```
+create-checks/
+├── src/
+│   ├── index.js              # CLI entrypoint (#!/usr/bin/env node)
+│   └── templates/
+│       ├── eslint.config.js  # copied into the user's project
+│       └── prettier.config.js
+├── __tests__/
+│   └── integration/
+│       └── index.int.test.js # spawns the CLI in a temp dir
+├── .github/workflows/
+│   ├── pull-request-checks.yml
+│   └── semantic-release.yml
+├── release.config.mjs        # semantic-release configuration
+└── package.json
+```
+
+---
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "create-checks",
+  "version": "1.0.1",
+  "description": "Scaffolding CLI that installs ESLint + Prettier and injects config into any project",
+  "author": "jeportie",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/jeportie/create-checks.git"
+  },
+  "keywords": [
+    "eslint",
+    "prettier",
+    "scaffolding",
+    "create",
+    "cli"
+  ],
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "bin": {
+    "create-checks": "src/index.js"
+  },
+  "files": [
+    "src"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "format": "prettier . --write",
+    "lint": "eslint .",
+    "secretlint": "secretlint ./src --maskSecrets",
+    "spellcheck": "cspell --no-progress \"./**/*.{js,mjs,cjs,md,json,yml}\"",
+    "test": "vitest --run",
+    "test:coverage": "vitest --coverage --run",
+    "test:integration": "vitest int --run",
+    "prepare": "husky || true"
+  },
+  "dependencies": {
+    "execa": "^8.0.1",
+    "fs-extra": "^11.2.0",
+    "picocolors": "^1.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.3.0",
+    "@commitlint/config-conventional": "^19.2.2",
+    "@eslint/js": "^9.0.0",
+    "@secretlint/secretlint-rule-pattern": "^8.2.4",
+    "@secretlint/secretlint-rule-preset-recommend": "^8.2.4",
+    "@vitest/coverage-v8": "^2.0.4",
+    "commitlint-plugin-cspell": "^0.1.1",
+    "conventional-changelog-conventionalcommits": "~8.0.0",
+    "cspell": "^8.12.1",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "husky": "^9.1.1",
+    "lint-staged": "^15.2.7",
+    "prettier": "^3.3.3",
+    "secretlint": "^8.2.4",
+    "semantic-release": "~24.0.0",
+    "vitest": "^2.0.4"
+  }
+}

package/src/index.js

@@ -0,0 +1,54 @@
+#!/usr/bin/env node
+
+import fs from 'fs-extra';
+import { execa } from 'execa';
+import pc from 'picocolors';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const cwd = process.cwd();
+
+console.log(pc.cyan('🔧 Setting up ESLint + Prettier...'));
+
+/* ---------------- INSTALL DEPENDENCIES ---------------- */
+
+if (!process.env.NO_INSTALL) {
+  await execa(
+    'npm',
+    [
+      'install',
+      '-D',
+      'eslint',
+      'prettier',
+      'eslint-config-prettier',
+      'typescript-eslint',
+      '@stylistic/eslint-plugin',
+      'eslint-plugin-import',
+      'eslint-import-resolver-typescript',
+    ],
+    { stdio: 'inherit' },
+  );
+}
+
+/* ---------------- COPY TEMPLATE FILES ---------------- */
+
+await fs.copyFile(path.join(__dirname, 'templates/eslint.config.js'), path.join(cwd, 'eslint.config.js'));
+
+await fs.copyFile(path.join(__dirname, 'templates/prettier.config.js'), path.join(cwd, 'prettier.config.js'));
+
+/* ---------------- UPDATE package.json ---------------- */
+
+const pkgPath = path.join(cwd, 'package.json');
+const pkg = await fs.readJson(pkgPath);
+
+pkg.scripts = {
+  ...pkg.scripts,
+  lint: 'eslint .',
+  format: 'prettier . --write',
+  typecheck: 'tsc --noEmit',
+};
+
+await fs.writeJson(pkgPath, pkg, { spaces: 2 });
+
+console.log(pc.green('✅ ESLint + Prettier configured successfully!'));

package/src/templates/eslint.config.js

@@ -0,0 +1,95 @@
+import eslint from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import stylistic from '@stylistic/eslint-plugin';
+import importPlugin from 'eslint-plugin-import';
+import prettier from 'eslint-config-prettier';
+
+export default tseslint.config(
+  {
+    ignores: [
+      '**/dist/**',
+      '**/node_modules/**',
+      '**/coverage/**',
+      '**/.vite/**',
+    ],
+  },
+
+  eslint.configs.recommended,
+
+  ...tseslint.configs.recommendedTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+
+  {
+    plugins: {
+      '@stylistic': stylistic,
+      import: importPlugin,
+    },
+
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+
+    settings: {
+      'import/resolver': {
+        typescript: true,
+        node: true,
+      },
+    },
+
+    rules: {
+      /* ---------------- IMPORTS ---------------- */
+      'import/first': 'error',
+      'import/no-cycle': 'error',
+      'import/no-self-import': 'error',
+      'import/no-unresolved': 'error',
+      'import/no-useless-path-segments': 'error',
+      'import/order': [
+        'error',
+        {
+          alphabetize: { order: 'asc', caseInsensitive: true },
+          groups: [
+            'builtin',
+            'external',
+            'internal',
+            'parent',
+            ['sibling', 'index'],
+            'type',
+          ],
+          'newlines-between': 'always',
+        },
+      ],
+
+      /* ---------------- STYLISTIC ---------------- */
+      '@stylistic/quotes': ['error', 'single', { avoidEscape: true }],
+      'spaced-comment': ['error', 'always'],
+
+      /* ---------------- TYPESCRIPT ---------------- */
+      '@typescript-eslint/no-unused-vars': [
+        'error',
+        { argsIgnorePattern: '^_' },
+      ],
+    },
+  },
+
+  /* ---------------- TEST OVERRIDES ---------------- */
+  {
+    files: ['**/*.test.{ts,tsx}', '**/*.spec.{ts,tsx}'],
+    rules: {
+      '@typescript-eslint/no-explicit-any': 'off',
+      '@typescript-eslint/no-unsafe-assignment': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+    },
+  },
+
+  /* ---------------- CONFIG FILES ---------------- */
+  {
+    files: ['*.config.{js,mjs,cjs}'],
+    ...tseslint.configs.disableTypeChecked,
+  },
+
+  /* ---------------- PRETTIER MUST BE LAST ---------------- */
+  prettier,
+);

package/src/templates/prettier.config.js

@@ -0,0 +1,12 @@
+export default {
+  printWidth: 80,
+  tabWidth: 2,
+  useTabs: false,
+  semi: true,
+  singleQuote: true,
+  trailingComma: 'all',
+  bracketSameLine: false,
+  bracketSpacing: true,
+  arrowParens: 'always',
+  proseWrap: 'never',
+};