chore(global): update dotfiles and fix formatting issues

.editorconfig

@@ -1,10 +1,7 @@
-# editorconfig.org
 root = true
 
 [*]
-charset = utf-8
 end_of_line = lf
-indent_size = 2
-indent_style = space
+charset = utf-8
 insert_final_newline = true
 trim_trailing_whitespace = true

.gitignore

@@ -1,153 +1,32 @@
-# https://github.com/toptal/gitignore/blob/master/templates/Node.gitignore
-
 # Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
 .pnpm-debug.log*
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
 
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Directory for instrumented libs generated by jscoverage/JSCover
-lib-cov
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# nyc test coverage
-.nyc_output
-
-# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
-.grunt
-
-# Bower dependency directory (https://bower.io/)
-bower_components
-
-# node-waf configuration
-.lock-wscript
-
-# Compiled binary addons (https://nodejs.org/api/addons.html)
-build/Release
-
-# Dependency directories
-node_modules/
-jspm_packages/
+# Dependency directory
+node_modules
 
-# Snowpack dependency directory (https://snowpack.dev/)
-web_modules/
+# NX Cache
+.nx
 
 # TypeScript cache
 *.tsbuildinfo
 
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
+# Eslint cache
 .eslintcache
 
-# Optional stylelint cache
+# Stylelint cache
 .stylelintcache
 
-# Microbundle cache
-.rpt2_cache/
-.rts2_cache_cjs/
-.rts2_cache_es/
-.rts2_cache_umd/
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variable files
-.env
-.env.development.local
-.env.test.local
-.env.production.local
-.env.local
-
-# parcel-bundler cache (https://parceljs.org/)
-.cache
-.parcel-cache
-
-# Next.js build output
-.next
-out
-
-# Nuxt.js build / generate output
-.nuxt
-dist
-
-# Gatsby files
-.cache/
-# Comment in the public line in if your project uses Gatsby and not Next.js
-# https://nextjs.org/blog/next-9-1#public-directory-support
-# public
-
-# vuepress build output
-.vuepress/dist
-
-# vuepress v2.x temp and cache directory
-.temp
-.cache
-
-# Docusaurus cache and generated files
-.docusaurus
-
-# Serverless directories
-.serverless/
-
-# FuseBox cache
-.fusebox/
-
-# DynamoDB Local files
-.dynamodb/
-
-# TernJS port file
-.tern-port
-
-# Stores VSCode versions used for testing VSCode extensions
-.vscode-test
-
-# yarn v2
-.yarn/cache
-.yarn/unplugged
-.yarn/build-state.yml
-.yarn/install-state.gz
-.pnp.*
-
-# https://github.com/toptal/gitignore/blob/master/templates/Turbo.gitignore
-
-# Turborepo task cache
-.turbo
-
-# Custom Additions
-
 # Bundle output directories
 dist/
-build/
 
-# Jest folder of detailed test coverage
-coverage/
+# Storybook bundle output
+storybook-static
 
-# nx
-nx-cloud.env
-.nx
+# Jest test coverage
+coverage
 
-# Storybook
-storybook-static
+# Env files
+nx-cloud.env

.prettierignore

@@ -1,4 +1,5 @@
 dist
 coverage
+.nx
 pnpm-lock.yaml
 CHANGELOG.md

.prettierrc.cjs

@@ -1,5 +1,4 @@
 module.exports = {
-  endOfLine: 'lf',
   printWidth: 120,
   singleQuote: true,
 };

docs/repo/ARCHITECTURE.md

@@ -41,11 +41,15 @@ We are using `lint-staged` to run linting and tests on staged files. This is the
 
 1. Check for secrets (`secretlint`)
 2. Fix file formatting (`prettier`)
-3. Lint and fix issues of affected `.ts` and related files (`eslint` and `nx`)
-4. Run tests of affected files (`jest`/`vitest` and `nx`)
+3. Lint `package.json` files for package, dependency, and monorepo best practices
+4. Lint and fix issues of affected `.ts` and related files (`eslint` and `nx`)
+5. Run tests of affected files (`jest`/`vitest` and `nx`)
+6. Lint exports on all `.ts` files (`knip` and `nx`)
 
 We limit automatic fixes to file formatting and linting when possible. For everything else, we let the user to decide on actions to take if there are errors.
 
+We also use Github actions as an extra safeguard in case users bypass `lint-staged`.
+
 ## Versioning
 
 All packages including `peerDependencies` are configured to use exact versions of packages. I prefer to have exact package versions to simplify debugging and reduce the likelihood of compatibility issues. I use `renovate` to automatically handle version updates.
@@ -84,3 +88,7 @@ import { Button, type ButtonProps } from '@waldronmatt/demo-ui/lib/index.js';
 ```
 
 There are other ways to do this such as symlinking and/or stubbing via third-party packages, but I personally ran into issues using these other methods. Alternatively, some may choose to refernce them via a registry (`npm`) with specified versions so that changes do not break other apps in the monorepo. This may be preferred for larger teams and organizations.
+
+## ESM and CJS File Naming Conventions
+
+For the rare instances where I have both `esm` and `cjs` bundles, I set specific file extensions like `.cjs` for `cjs` and use the standard `.js` extension for `esm`. ESM is the module system industry standard and I would prefer to not label them specifically with a `.mjs` extension. Labelling `cjs` files differently helps to remind developers to upgrade in the future if both module systems must be supported.

docs/repo/CICD.md

@@ -6,20 +6,26 @@ Installer command to ensure that the exact versions of dependencies specified in
 pnpm bootstrap:ci
 ```
 
-Versioning command that will bypass prompts for avoiding manual intervention:
+Lint the monorepo:
 
 ```bash
-pnpm version:ci
+pnpm lint:mr
 ```
 
-Publishing command that will bypass prompts for avoiding manual intervention:
+Found in the workflow `.yml` cicd files, this command will run all three tasks in parallel for only affected files:
 
 ```bash
-pnpm publish:ci
+npx nx affected -t build,lint,test,lint:knip --parallel=4
 ```
 
-Found in the workflow `.yml` cicd files, this command will run all three tasks in parallel for only affected files:
+Versioning command that will bypass prompts for avoiding manual intervention:
 
 ```bash
-npx nx affected -t build,lint,test --parallel=3
+pnpm version:ci
+```
+
+Publishing command that will bypass prompts for avoiding manual intervention:
+
+```bash
+pnpm publish:ci
 ```

docs/repo/COMMANDS.md

@@ -20,6 +20,12 @@ Delete workspace root `node_modules` and `pnpm-lock.yaml` files:
 pnpm delete
 ```
 
+Find unused exports (applies to projects in `packages` folder):
+
+```bash
+pnpm lint:knip
+```
+
 Visualize the project structure/dependencies:
 
 ```bash

docs/repo/MONOREPO.md

@@ -1,6 +1,6 @@
 # Monorepo Commands
 
-Lint your monorepo (executes all commands below):
+Lint the monorepo (executes all commands below):
 
 ```bash
 pnpm lint:mr
@@ -18,7 +18,7 @@ Check files for formatting issues:
 pnpm lint:format
 ```
 
-Validate package publishing best practices:
+Validate package publishing best practices (applies to projects in `packages` folder):
 
 ```bash
 pnpm lint:packages
@@ -35,9 +35,3 @@ Verify monorepo best practice:
 ```bash
 pnpm lint:monorepo
 ```
-
-Find unused exports:
-
-```bash
-pnpm lint:knip
-```

docs/ui/tsconfig.json

@@ -4,6 +4,6 @@
   "include": ["src"],
   "exclude": ["node_modules", "dist", "coverage"],
   "compilerOptions": {
-    "types": ["vitest/globals"],
-  },
+    "types": ["vitest/globals"]
+  }
 }

lint-staged.config.cjs

@@ -1,5 +1,6 @@
 module.exports = {
   '*': ['secretlint', 'prettier --cache --write --ignore-unknown'],
+  '**/package.json': ['node ./publint.js', 'npx syncpack lint --config .syncpackrc', 'manypkg check'],
   '*.{cjs,js,jsx,ts,tsx}': ['nx affected -t lint --fix --files'],
-  '*.{ts,tsx}': ['nx affected -t test --files'],
+  '*.{ts,tsx}': ['nx affected -t test --files', 'npx nx run-many -t lint:knip'],
 };

package.json

@@ -17,18 +17,18 @@
     "commit": "git-cz",
     "delete": "rimraf pnpm-lock.yaml .nx node_modules",
     "lint:secrets": "npx secretlint **/*",
-    "lint:format": "prettier --check .",
+    "lint:format": "prettier --write .",
     "lint:packages": "node ./publint.js",
     "lint:deps": "npx syncpack lint --config .syncpackrc",
     "lint:monorepo": "npx manypkg check",
-    "lint:knip": "knip --exports",
-    "lint:mr": "run-p lint:secrets lint:format lint:packages lint:deps lint:monorepo lint:knip",
+    "lint:mr": "run-p lint:secrets lint:format lint:packages lint:deps lint:monorepo",
     "nx:graph": "npx nx graph",
     "update:deps": "npx syncpack update",
     "list:deps": "npx syncpack list",
     "list:packages": "lerna ls -l -all",
     "list:changed": "lerna changed -l -all",
     "dev": "npx nx run-many -t dev",
+    "lint:knip": "npx nx run-many -t lint:knip",
     "lint": "npx nx run-many -t lint",
     "test": "npx nx run-many -t test",
     "test:watch": "npx nx run-many -t test:watch",
@@ -50,7 +50,7 @@
     "@lerna-lite/version": "3.3.1",
     "@manypkg/cli": "0.21.3",
     "@nrwl/cli": "15.9.3",
-    "@nrwl/nx-cloud": "16.5.2",
+    "@nrwl/nx-cloud": "18.0.1",
     "@secretlint/secretlint-rule-preset-recommend": "8.1.2",
     "@types/node": "20.11.30",
     "commitizen": "4.3.0",

packages/basic-math/package.json

@@ -18,6 +18,7 @@
     "README.md"
   ],
   "scripts": {
+    "lint:knip": "knip --exports",
     "lint": "eslint . --ext ts --report-unused-disable-directives --max-warnings 0",
     "test": "jest --coverage",
     "test:watch": "jest --watch",

packages/basic-math/tsconfig.json

@@ -4,6 +4,6 @@
   "include": ["src/**/*.ts"],
   "exclude": ["node_modules", "dist", "coverage"],
   "compilerOptions": {
-    "baseUrl": "./",
-  },
+    "baseUrl": "./"
+  }
 }

packages/parity/package.json

@@ -18,6 +18,7 @@
     "README.md"
   ],
   "scripts": {
+    "lint:knip": "knip --exports",
     "lint": "eslint . --ext ts --report-unused-disable-directives --max-warnings 0",
     "test": "jest --coverage",
     "test:watch": "jest --watch",

packages/parity/tsconfig.json

@@ -4,6 +4,6 @@
   "include": ["src/**/*.ts"],
   "exclude": ["node_modules", "dist", "coverage"],
   "compilerOptions": {
-    "baseUrl": "./",
-  },
+    "baseUrl": "./"
+  }
 }

packages/tokens-ui/package.json

@@ -24,6 +24,7 @@
     "**/*.css"
   ],
   "scripts": {
+    "lint:knip": "knip --exports",
     "lint": "eslint . --ext ts,tsx --report-unused-disable-directives --max-warnings 0",
     "build": "tsc --p ./tsconfig.build.json && vite build",
     "clean": "rimraf dist coverage tsconfig.build.tsbuildinfo"

packages/tokens-ui/tsconfig.json

@@ -7,6 +7,6 @@
     "outDir": "dist",
     "baseUrl": "./",
     "declaration": true,
-    "declarationMap": true,
-  },
+    "declarationMap": true
+  }
 }