refactor: next version of repo template (#358)

.github/dependabot.yml

···
       # TEMP: ignore eslint major version (v9) until typescript-eslint releases v8
       - dependency-name: "eslint"
         update-types: ["version-update:semver-major"]
+      - dependency-name: "@eslint/js"
+        update-types: ["version-update:semver-major"]
     groups:
       typescript:
         patterns:

README.md

···
 
 ## Getting started
 
-### Creating a new repository
-
-#### GitHub UI
-
-You can create a new repository based on this template by clicking the "Use this template" button in the top-right corner of this page.
-
-#### Terminal
-
-You can run the following command below with the [GitHub CLI](https://cli.github.com/). Some notes:
-
-- Replace placeholder with name of your extension in upper CamelCase
-- Configure your repository's visibility with `--public`, `--private`, or `--internal`
-
-```shell
-gh repo create {{package}} --public --clone --template neoncitylights/typescript
-```
-
-### Cookiecutter stuff
-
-Using your favorite text editor or IDE, find-and-replace the following placeholders:
-
-- `@author/package`: Replace this with the name of your package. This can be scoped under a user/organization (e.g `@samantha/my-really-cool-package`). **Note**: This placeholder is different than the others to avoid warnings from the NPM client.
-- `{{author}}`: Replace this with your GitHub/npm username, or the name of your organization.
-- `{{package}}`: Replace this with the name of your library.
-- `{{desc}}`: Replace this with a short description of your library.
-
-## Publishing a package
-
-if you haven't authenticated with the NPM CLI already, you'll need to do that first by running [`npm adduser`](https://docs.npmjs.com/cli/v9/commands/npm-adduser) in the terminal.
-
-- To publish a non-scoped package (e.g `my-cool-package`), run `npm publish`
-- To publish a [scoped package](https://docs.npmjs.com/cli/v9/using-npm/scope) (e.g `@namespace/my-cool-package`), pass the `--access` flag, which must be either `public` or `private`. For example:
+### Create a new repository
 
+Choose a method:
+- **GitHub UI**: Press the "Use this template" button in the top-right corner of this page.
+- **GitHub CLI**: Install [GitHub CLI](https://cli.github.com). Then run one of the following:
   ```shell
-  npm publish --access public
+  gh repo create --template neoncitylights/typescript --public --clone {{package}} # clone as public
+  gh repo create --template neoncitylights/typescript --private --clone {{package}} # clone as private
   ```
 
-> [!NOTE]
-> To publish a private package on NPM, you must have [npm Pro](https://www.npmjs.com/products/pro).
+### Replace placeholders
 
-### GitHub Actions
+Using your text editor or IDE, find-and-replace the following placeholders:
 
-For your CI environment (when using GitHub Actions), you'll need to set the `NPM_TOKEN` environment variable to the value of your NPM token. You can find this by running `npm token list` in the terminal, and create a token by running `npm token create`.
+- `@author/package`: Replace this with the author's name (e.g a user or organization) and package's name.
+  - **Note**: This placeholder is different than the others to avoid warnings from the NPM client.
+- `{{author}}`: Replace this with the author's name (e.g real name, GitHub username, or organization).
+- `{{package}}`: Replace this with the name of the package.
+- `{{desc}}`: Replace this with a short description of the package.
 
-To add your token to your repository:
+## Publishing a package
+```shell
+# Enter the root directory of the package you want to publish
+cd packages/pkg1
 
-1. Go to Settings > Security (Secrets and Variables) > Actions
-2. Press "New repository secret" button
-3. Enter `NPM_TOKEN` as the name of the secret
-4. Copy and paste the token value
-5. Press "Add secret" button
+# if package is scoped, e.g "hello-world"
+npm publish
+
+# if package is non-scoped, e.g "@user123/hello-world",
+# can also be published privately via `--access private` (requires npm pro plan)
+npm publish --access public
+```
 
 ## Configure
 
 ### NPM scripts
 
-NPM has core commands that can be overriden by package authors. I've tried to make this as zero-config as possible, so its likely you won't need to change them any further. These commands are:
-
-- [`prepare`](https://docs.npmjs.com/cli/v8/using-npm/scripts#life-cycle-scripts)
-- [`prepublishOnly`](https://docs.npmjs.com/cli/v8/using-npm/scripts#life-cycle-scripts)
-
-These are the most relevant commands that you'll likely use:
-
 | Command | Description |
 | ------- | ----------- |
 | `npm run build` | Build the library for distributing |
 | `npm run docs` | Generate documentation |
 | `npm run docs-watch` | Generate documentation in watch mode|
 | `npm run clean` | Remove all generated files |
-| `npm run reinstall` | Cleans and reinstalls dependencies |
-| `npm run lint` | Check for linting errors |
-| `npm run lint-fix` | Fix linting errors |
 | `npm run test` | Run unit tests |
 | `npm run test-ci` | Run unit tests in CI mode |
 | `npm run test-ui` | Run unit tests in UI/browser mode |
 | `npm run test-watch` | Run unit tests in watch mode |
+| `npm run lint` | Check for ESLint/publint errors |
+| `npm run lint-fix` | Fix ESLint errors (publint errors must be fixed manually) |
+| `npm run eslint` | Check for ESLint errors |
+| `npm run eslint-fix` | Fix ESLint errors |
+| `npm run publint` | Check for NPM packaging errors |
 
 ### Developer tools
 
 | Tool | File | Documentation |
 | ---- | ---- | ------------- |
 | NPM package | [`package.json`](package.json) | [docs](https://docs.npmjs.com/cli/v10/configuring-npm/package-json), [website](https://docs.npmjs.com/) |
-| TypeDoc (documentation generator) | [`package.json`](package.json) (`typedocOptions`) | [docs](https://typedoc.org/options/configuration/), [website](https://typedoc.org/) |
-| TypeScript | [`packages/tsconfig.json`](packages/tsconfig.json) | [docs](https://www.typescriptlang.org/tsconfig), [website](https://www.typescriptlang.org/) |
+| TypeScript | [`tsconfig.json`](./tsconfig.json), [`packages/*/tsconfig.json`](packages/pkg1/tsconfig.json) | [docs](https://www.typescriptlang.org/tsconfig), [website](https://www.typescriptlang.org/) |
+| TypeDoc (documentation generator) | [`tsconfig.json`](tsconfig.json) (`typedocOptions`) | [docs](https://typedoc.org/options/configuration/), [website](https://typedoc.org/) |
 | ESLint (code formatter + linter) | [`eslint.config.js`](./eslint.config.js) | [docs](https://eslint.org/docs/latest/use/configure/), [website](https://eslint.org/) |
 | Vite (bundler) | [`vite.config.ts`](packages/pkg1/vite.config.ts) | [docs](https://vitejs.dev/config/), [website](https://vitejs.dev/) |
-| Vitest (testing framework) | [`vite.config.ts`](packages/pkg1/vite.config.ts) (`test`) | [docs](https://vitest.dev/config/), [website](https://vitest.dev/) |
+| Vitest (testing framework) | [`packages/*/vite.config.ts`](packages/pkg1/vite.config.ts) (`test`) | [docs](https://vitest.dev/config/), [website](https://vitest.dev/) |
 | Vitest workspace | [`vitest.workspace.ts`](./vitest.workspace.ts) | [docs](https://vitest.dev/guide/workspace.html#workspace) |
 | Dependabot | [`.github/dependabot.yml`](./.github/dependabot.yml) | [docs](https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file), [website](https://github.com/dependabot) |
 

eslint.config.js

···
 import stylistic from '@stylistic/eslint-plugin'
 
 export default tsEslint.config(
+	{
+		ignores: [
+			'**/dist/',
+			'docs/typedoc',
+		],
+	},
 	stylistic.configs.customize({
 		indent: 'tab',
 		quote: 'single',
···
 		jsx: true,
 	}),
 	eslint.configs.recommended,
-	...tsEslint.configs.recommendedTypeChecked,
-	...tsEslint.configs.stylisticTypeChecked,
+	...tsEslint.configs.recommended,
+	...tsEslint.configs.stylistic,
 	{
 		languageOptions: {
 			parserOptions: {
 				project: [
 					'./tsconfig.eslint.json',
-					'packages/*/tsconfig.json'
+					'./packages/**/tsconfig.eslint.json',
 				],
 				tsconfigRootDir: import.meta.dirname,
 			},
-		}
+		},
 	},
 )

package-lock.json

···
 				"packages/**"
 			],
 			"devDependencies": {
-				"@eslint/js": "^9.7.0",
+				"@eslint/js": "^8.57.0",
 				"@stylistic/eslint-plugin": "^2.3.0",
 				"@types/eslint__js": "^8.42.3",
 				"@types/node": "^20.14.11",
···
 			}
 		},
 		"node_modules/@eslint/js": {
-			"version": "9.7.0",
-			"resolved": "https://registry.npmjs.org/@eslint/js/-/js-9.7.0.tgz",
-			"integrity": "sha512-ChuWDQenef8OSFnvuxv0TCVxEwmu3+hPNKvM9B34qpM0rDRbjL8t5QkQeHHeAfsKQjuH9wS82WeCi1J/owatng==",
+			"version": "8.57.0",
+			"resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.0.tgz",
+			"integrity": "sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g==",
 			"dev": true,
+			"license": "MIT",
 			"engines": {
-				"node": "^18.18.0 || ^20.9.0 || >=21.1.0"
+				"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
 			}
 		},
 		"node_modules/@humanwhocodes/config-array": {
···
 			},
 			"funding": {
 				"url": "https://opencollective.com/eslint"
-			}
-		},
-		"node_modules/eslint/node_modules/@eslint/js": {
-			"version": "8.57.0",
-			"resolved": "https://registry.npmjs.org/@eslint/js/-/js-8.57.0.tgz",
-			"integrity": "sha512-Ys+3g2TaW7gADOJzPt83SJtCDhMjndcDMFVQ/Tj9iA1BfJzFKD9mAUXT3OenpuPHbI6P/myECxRJrofUsDx/5g==",
-			"dev": true,
-			"license": "MIT",
-			"engines": {
-				"node": "^12.22.0 || ^14.17.0 || >=16.0.0"
 			}
 		},
 		"node_modules/espree": {
···
 			"license": "MIT",
 			"funding": {
 				"type": "individual",
-				"url": "https://github.com/sponsors/something"
+				"url": "https://github.com/sponsors/{{author}}"
 			}
 		}
 	}

package.json

···
 	],
 	"scripts": {
 		"build": "npm run build -ws --if-present",
-		"build-all": "npm run build && npm run docs",
 		"docs": "typedoc",
 		"docs-watch": "npm run docs -- --watch",
 		"clean": "rm -rf ./docs/typedoc/ ./node_modules && rm -rf ./package-lock.json",
-		"reinstall": "npm run clean && npm install",
 		"test": "vitest --coverage",
 		"test-ci": "npm run test -- run",
 		"test-ui": "npm run test -- --ui",
 		"test-watch": "npm run test -- --watch",
-		"test-all": "npm run test-ci && npm run lint",
 		"lint": "npm run eslint && npm run publint",
 		"lint-fix": "npm run eslint-fix",
-		"eslint": "eslint packages/*/src/** --cache",
+		"eslint": "eslint . --cache",
 		"eslint-fix": "npm run eslint -- --fix",
+		"eslint-debug": "eslint --print-config eslint.config.js",
 		"publint": "npm run publint -ws"
 	},
 	"devDependencies": {
-		"@eslint/js": "^9.7.0",
+		"@eslint/js": "^8.57.0",
 		"@stylistic/eslint-plugin": "^2.3.0",
 		"@types/eslint__js": "^8.42.3",
 		"@types/node": "^20.14.11",
···
 		"vite": "^5.3.4",
 		"vite-plugin-dts": "^3.9.1",
 		"vitest": "^2.0.3"
-	},
-	"typedocOptions": {
-		"out": "docs/typedoc",
-		"entryPoints": ["packages/*"],
-		"entryPointStrategy": "packages",
-		"includeVersion": false,
-		"lightHighlightTheme": "github-light",
-		"darkHighlightTheme": "github-dark"
 	}
 }

packages/pkg1/tests/basic.test.ts

···
-import { expect, test } from 'vitest';
-
-import { greet } from '../src/index';
+import { expect, test } from 'vitest'
+import { greet } from '../src'
 
 test('greet runs correctly', () => {
-	expect(greet('John')).toBe('Hello, John!');
-});
+	expect(greet('John')).toBe('Hello, John!')
+})

packages/pkg1/tsconfig.eslint.json

···
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"noEmit": true
+	},
+	"exclude": [
+		"dist",
+		"docs"
+	],
+	"include": [
+		"src",
+		"tests",
+		"vite.config.ts"
+	]
+}

packages/pkg1/tsconfig.json

···
 {
-	"extends": "../tsconfig.base.json",
 	"include": [
-		"src"
+		"./src"
 	],
-	"exclude": [
-		"node_modules",
-		"**/tests/*",
-		"**/__tests__/*"
-	],
+	"compilerOptions": {
+		/* base options */
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"allowJs": true,
+		"resolveJsonModule": true,
+		"verbatimModuleSyntax": true,
+		"moduleDetection": "force",
+		"rootDir": "./src",
+
+		/* transpilation */
+		"lib": [ "ES2022" ],
+		"target": "ES2022",
+		"module": "ESNext",
+		"moduleResolution": "Bundler",
+		"isolatedModules": true,
+		"sourceMap": true,
+		"declaration": true,
+		"declarationMap": true,
+		"composite": true,
+
+		/* strictness */
+		"strict": true,
+		"forceConsistentCasingInFileNames": true,
+		"allowUnusedLabels": false,
+		"allowUnreachableCode": false,
+		"exactOptionalPropertyTypes": true,
+		"noFallthroughCasesInSwitch": true,
+		"noImplicitOverride": true,
+		"noImplicitReturns": true,
+		"noPropertyAccessFromIndexSignature": true,
+		"noUncheckedIndexedAccess": true,
+		"noUnusedLocals": true,
+		"noUnusedParameters": true,
+
+		/** ES support */
+		"useDefineForClassFields": true,
+	},
 	"typedocOptions": {
 		"entryPoints": [
 			"src/index.ts"

packages/pkg1/vite.config.ts

···
-import dts from 'vite-plugin-dts';
-import { defineProject } from 'vitest/config';
+import dts from 'vite-plugin-dts'
+import { defineProject } from 'vitest/config'
 
 export default defineProject({
 	build: {
···
 			fileName: () => '{{package}}.mjs',
 		},
 	},
-	define: { 
-		'import.meta.vitest': 'undefined', 
+	define: {
+		'import.meta.vitest': 'undefined',
 	},
 	plugins: [
 		dts({
···
 		coverage: {
 			include: ['src/**/*.{js,ts}'],
 			provider: 'v8',
-			reporter: [ 'text', 'json', 'html' ],
+			reporter: ['text', 'json', 'html'],
 		},
 	},
-});
+})

packages/tsconfig.base.json

···
-// Handbook: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
-// Reference: https://www.typescriptlang.org/tsconfig
-{
-	"compilerOptions": {
-		"composite": true,
-		/* base options */
-		"esModuleInterop": true,
-		"skipLibCheck": true,
-		"allowJs": true,
-		"resolveJsonModule": true,
-		"verbatimModuleSyntax": true,
-		"moduleDetection": "force",
-
-		/* strictness */
-		"strict": true,
-		"forceConsistentCasingInFileNames": true,
-		"allowUnusedLabels": false,
-		"allowUnreachableCode": false,
-		"exactOptionalPropertyTypes": true,
-		"noFallthroughCasesInSwitch": true,
-		"noImplicitOverride": true,
-		"noImplicitReturns": true,
-		"noPropertyAccessFromIndexSignature": true,
-		"noUncheckedIndexedAccess": true,
-		"noUnusedLocals": true,
-		"noUnusedParameters": true,
-
-		/** ES support */
-		"useDefineForClassFields": true,
-
-		/* transpilation */
-		"lib": [ "ES2022" ],
-		"target": "ES2022",
-		"module": "ESNext",
-		"moduleResolution": "Bundler",
-		"isolatedModules": true,
-		"baseUrl": "./src",
-		"sourceMap": true,
-		"declaration": true,
-		"declarationMap": true,
-		"types": [
-			"vitest/importMeta"
-		]
-	}
-}

packages/tsconfig.json

···
-// Handbook: https://www.typescriptlang.org/docs/handbook/tsconfig-json.html
-// Reference: https://www.typescriptlang.org/tsconfig
-{
-	"compilerOptions": {
-		// monorepo setup
-		// - composite: cache builds with a .tsbuildinfo
-		// - sourceMap/declarationMap: enable to ensure go-to definitions
-		//   will work properly
-		"declaration": true,
-		"composite": true,
-		"sourceMap": true,
-		"declarationMap": true,
-		"esModuleInterop": true
-	},
-	"references": [
-		{ "path": "pkg1" }
-	]
-}

tsconfig.eslint.json

···
 {
+	"extends": "./tsconfig.json",
 	"compilerOptions": {
-		"noEmit": true,
-		"strict": true
+		"noEmit": true
 	},
+	"exclude": [],
 	"include": [
-		"packages/*/src"
-	],
-	"exclude": []
+		"eslint.config.js",
+		"vitest.workspace.ts"
+	]
 }

tsconfig.json

···
+{
+	"compilerOptions": {
+		"module": "ESNext",
+		"moduleResolution": "Bundler"
+	},
+	"typedocOptions": {
+		"out": "docs/typedoc",
+		"entryPoints": ["packages/*"],
+		"entryPointStrategy": "packages",
+		"includeVersion": false,
+		"lightHighlightTheme": "github-light",
+		"darkHighlightTheme": "github-dark"
+	}
+}

vitest.workspace.ts

···
-import { defineWorkspace } from 'vitest/config';
+import { defineWorkspace } from 'vitest/config'
 
 // defineWorkspace provides a nice type hinting DX
 export default defineWorkspace([
 	'packages/*',
-]);
+])