voss-node-configs 1.0.0

package/README.md

@@ -0,0 +1,119 @@
+# Node Configs Voss
+
+Shared TypeScript and ESLint configurations for Node.js projects.
+
+## Installation
+
+```bash
+npm install --save-dev node-configs-voss
+```
+
+## TypeScript Configs
+
+### Usage
+
+```json
+// tsconfig.json
+{
+  "extends": "node-configs-voss/typescript/base"
+}
+```
+
+### Available Configs
+
+- `typescript/base` - Base TypeScript configuration
+- `typescript/common` - Common TypeScript configuration
+- `typescript/back-end` - Backend-specific TypeScript configuration
+- `typescript/front-end-base` - Frontend base TypeScript configuration
+- `typescript/front-end-dev` - Frontend development TypeScript configuration
+- `typescript/front-end-build` - Frontend build TypeScript configuration
+- `typescript/front-end-node` - Frontend Node.js TypeScript configuration
+
+## ESLint Configs
+
+### Installation
+
+You'll also need to install the required ESLint dependencies:
+
+```bash
+npm install --save-dev eslint@^9.0.0 @typescript-eslint/eslint-plugin@^7.0.0 @typescript-eslint/parser@^7.0.0
+```
+
+### Usage
+
+```javascript
+// eslint.config.js
+module.exports = {
+  extends: ['node-configs-voss/eslint/base'],
+};
+```
+
+### Available Configs
+
+- `eslint/base` - Base ESLint configuration with TypeScript support
+- `eslint/back-end` - Backend-specific ESLint configuration
+- `eslint/front-end` - Frontend-specific ESLint configuration
+- `eslint/node` - Node.js specific ESLint configuration
+
+## Examples
+
+### Backend Project
+
+**tsconfig.json:**
+```json
+{
+  "extends": "node-configs-voss/typescript/back-end"
+}
+```
+
+**eslint.config.js:**
+```javascript
+module.exports = {
+  extends: ['node-configs-voss/eslint/back-end'],
+};
+```
+
+### Frontend Project
+
+**tsconfig.json:**
+```json
+{
+  "extends": "node-configs-voss/typescript/front-end-base"
+}
+```
+
+**eslint.config.js:**
+```javascript
+module.exports = {
+  extends: ['node-configs-voss/eslint/front-end'],
+};
+```
+
+## Configuration Details
+
+### TypeScript Configs
+
+- **base**: Strict TypeScript configuration with modern ES features
+- **common**: Common settings for shared libraries
+- **back-end**: Optimized for Node.js backend development
+- **front-end-***: Various frontend configurations for different build targets
+
+### ESLint Configs
+
+- **base**: Comprehensive TypeScript linting with modern JavaScript rules
+- **back-end**: Allows console usage and CommonJS requires
+- **front-end**: Warns about console usage and enforces ES modules
+- **node**: Node.js specific rules with process.exit prevention
+
+## Development
+
+To contribute to this package:
+
+1. Make changes to the config files
+2. Test locally with a sample project
+3. Update version in package.json
+4. Publish to npm
+
+## License
+
+MIT 

package/eslint/back-end.js

@@ -0,0 +1,13 @@
+module.exports = {
+  extends: ['./base.js'],
+  env: {
+    node: true,
+    es2022: true,
+  },
+  rules: {
+    // Backend-specific rules
+    'no-console': 'off', // Allow console in backend
+    '@typescript-eslint/no-require-imports': 'off', // Allow require() in backend
+    'global-require': 'off', // Allow require() anywhere in backend
+  },
+}; 

package/eslint/base.js

@@ -0,0 +1,35 @@
+module.exports = {
+  extends: [
+    'eslint:recommended',
+    '@typescript-eslint/recommended',
+    '@typescript-eslint/recommended-requiring-type-checking',
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 'latest',
+    sourceType: 'module',
+    project: './tsconfig.json',
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    // Base rules for all projects
+    '@typescript-eslint/no-unused-vars': 'error',
+    '@typescript-eslint/no-explicit-any': 'warn',
+    '@typescript-eslint/prefer-const': 'error',
+    '@typescript-eslint/no-var-requires': 'error',
+    'prefer-const': 'error',
+    'no-var': 'error',
+    'no-console': 'off', // Allow console by default, can be overridden
+    'no-debugger': 'error',
+    'no-duplicate-imports': 'error',
+    'no-unreachable': 'error',
+    'prefer-arrow-callback': 'error',
+    'prefer-template': 'error',
+    'template-curly-spacing': 'error',
+    'object-curly-spacing': ['error', 'always'],
+    'array-bracket-spacing': ['error', 'never'],
+    'comma-dangle': ['error', 'always-multiline'],
+    'semi': ['error', 'always'],
+    'quotes': ['error', 'single', { 'avoidEscape': true }],
+  },
+}; 

package/eslint/front-end.js

@@ -0,0 +1,13 @@
+module.exports = {
+  extends: ['./base.js'],
+  env: {
+    browser: true,
+    es2022: true,
+  },
+  rules: {
+    // Frontend-specific rules
+    'no-console': 'warn', // Warn about console in frontend
+    '@typescript-eslint/no-require-imports': 'error', // Disallow require() in frontend
+    'global-require': 'error', // Disallow require() in frontend
+  },
+}; 

package/eslint/node.js

@@ -0,0 +1,15 @@
+module.exports = {
+  extends: ['./base.js'],
+  env: {
+    node: true,
+    es2022: true,
+  },
+  rules: {
+    // Node.js specific rules
+    'no-console': 'off', // Allow console in Node.js
+    '@typescript-eslint/no-require-imports': 'off', // Allow require() in Node.js
+    'global-require': 'off', // Allow require() anywhere in Node.js
+    'no-process-exit': 'error', // Prevent process.exit() usage
+    'no-sync': 'warn', // Warn about synchronous methods
+  },
+}; 

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "voss-node-configs",
+  "version": "1.0.0",
+  "description": "Shared TypeScript and ESLint configs for Node.js projects",
+  "exports": {
+    "typescript/base": "./typescript/base.json",
+    "typescript/common": "./typescript/common.json",
+    "typescript/back-end": "./typescript/back-end/tsconfig.json",
+    "typescript/front-end-base": "./typescript/front-end.base.json",
+    "typescript/front-end-dev": "./typescript/front-end.dev.json",
+    "typescript/front-end-build": "./typescript/front-end.build.json",
+    "typescript/front-end-node": "./typescript/front-end.node.json",
+    "eslint/base": "./eslint/base.js",
+    "eslint/back-end": "./eslint/back-end.js",
+    "eslint/front-end": "./eslint/front-end.js",
+    "eslint/node": "./eslint/node.js"
+  },
+  "files": [
+    "typescript/",
+    "eslint/"
+  ],
+  "license": "MIT",
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/typescript/back-end/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "../back-end.json"
+}

package/typescript/back-end.json

@@ -0,0 +1,10 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "preserve",
+    "resolveJsonModule": true,
+    "target": "esnext",
+    "skipLibCheck": true,
+    "noEmit": true,
+  }
+}

package/typescript/base.json

@@ -0,0 +1,39 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "isolatedDeclarations": true,                     /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "strictBuiltinIteratorReturn": true,              /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
+    "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    "allowUnreachableCode": false,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */,
+  }
+}

package/typescript/common.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "esnext",
+    "target": "es2022",
+    "noEmit": true
+  },
+  "include": ["src"]
+}

package/typescript/front-end.base.json

@@ -0,0 +1,15 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "target": "ES2020",
+    "lib": ["DOM", "DOM.Iterable", "ESNext"],
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "jsx": "react-jsx",
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true,
+    "isolatedModules": true,
+    "types": ["vite/client"]
+  }
+}

package/typescript/front-end.build.json

@@ -0,0 +1,9 @@
+{
+  "extends": "./tsconfig.front-end.base.json",
+  "compilerOptions": {
+    "resolveJsonModule": true,
+    "allowImportingTsExtensions": false,
+    "noEmit": false
+  },
+  "include": ["src"]
+}

package/typescript/front-end.dev.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.front-end.base.json",
+  "compilerOptions": {
+    "noEmit": true,
+    "allowImportingTsExtensions": true
+  },
+  "include": ["src"]
+}

package/typescript/front-end.node.json

@@ -0,0 +1,17 @@
+{
+  "extends": "./base",
+  "compilerOptions": {
+    "target": "ES2022",
+    "module": "ESNext",
+    "moduleResolution": "node",
+    "skipLibCheck": true,
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "preserveSymlinks": true,
+    "strict": true,
+    "noEmit": true,
+    "types": ["node"]
+  }
+}