@vfourny/node-toolkit 1.0.1

package/.commitlintrc.js

@@ -0,0 +1,22 @@
+export default {
+  extends: ["@commitlint/config-angular"],
+  rules: {
+    "type-enum": [
+      2,
+      "always",
+      [
+        "build",
+        "ci",
+        "docs",
+        "feat",
+        "fix",
+        "perf",
+        "refactor",
+        "revert",
+        "style",
+        "test",
+        "chore",
+      ],
+    ],
+  },
+}

package/README.md

@@ -0,0 +1,107 @@
+# VFourny's Node Toolkit
+
+[![fr](https://img.shields.io/badge/lang-fr-blue)](https://github.com/vfourny/node-toolkit/blob/main/docs/README.fr.md)
+
+Welcome to **VFourny's Node Toolkit**! This repository contains a collection of tools and configurations designed to simplify development and automation for your projects.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Variables d'Environnement](#variables-d'environnement)
+- [Fichiers de Configuration](#fichiers-de-configuration)
+  - [Eslint](#eslint)
+  - [Prettier](#prettier)
+  - [TypeScript](#typescript)
+  - [Semantic Release](#semantic-release)
+  - [Commitlint](#commitlint)
+
+## Installation
+
+To install **VFourny's Node Toolkit** via npm, make sure you have [Node.js](https://nodejs.org/) installed on your machine. Then, run the following command in your terminal:
+
+```bash
+npm install -D @vfourny/node-toolkit
+```
+
+## Environment Variables
+
+For `semantic-release` to work properly, certain environment variables must be defined in your GitHub repository configuration.
+
+### Required Environment Variables
+
+- `NPM_TOKEN`: Access token for npm to publish packages.
+- `IS_PUBLISH`: Indicates whether the workflow should publish an npm package.
+
+## Configuration Files
+
+- `eslint.config.js`: ESLint configuration for JavaScript code linting.
+- `prettier.config.js`: Prettier configuration for JavaScript code formatting.
+- `tsconfig.json`: TypeScript configuration for transpiling TypeScript code.
+- `release.config.js`: Semantic Release configuration for version management.
+- `commitlintrc.js`: Commitlint configuration for commit message validation.
+
+### ESLint
+
+To import the ESLint configuration into your project, add the following code to your [ESLint](https://eslint.org/docs/latest/use/configure/configuration-files#configuration-file) configuration file:
+
+```javascript
+import nodeToolkitEslintConfig from "@vfourny/node-toolkit/eslint"
+
+export default {
+  ...nodeToolkitEslintConfig,
+  // Your custom configurations
+}
+```
+
+### Prettier
+
+To import the Prettier configuration into your project, add the following code to your [Prettier](https://prettier.io/docs/en/configuration.html) configuration file:
+
+```javascript
+import nodeToolkitPrettierConfig from "@vfourny/node-toolkit/prettier"
+
+export default {
+  ...nodeToolkitPrettierConfig,
+  // Your custom configurations
+}
+```
+
+### TypeScript
+
+To import the TypeScript configuration into your project, add the following code to your [TypeScript](https://www.typescriptlang.org/tsconfig) configuration file:
+
+```json
+{
+  "extends": "@vfourny/node-toolkit/tsconfig",
+  "compilerOptions": {
+    // Your custom configurations
+  }
+}
+```
+
+### Semantic Release
+
+To import the Semantic Release configuration into your project, add the following code to your [Semantic Release](https://semantic-release.gitbook.io/semantic-release) configuration file:
+
+```javascript
+import nodeToolkitReleaseConfig from "@vfourny/node-toolkit/release"
+
+export default {
+  extends: "@vfourny/node-toolkit/release",
+  // Your custom configurations
+}
+```
+
+### Commitlint
+
+To import the Commitlint configuration into your project, add the following code to your [Commitlint](https://commitlint.js.org/#/concepts-shareable-config) configuration file:
+
+```javascript
+export default {
+  extends: "@vfourny/node-toolkit/commitlint",
+}
+```
+
+---
+
+_Thank you for using **VFourny's Node Toolkit**! For any questions or support, please open an issue on the GitHub repository._

package/eslint.config.js

@@ -0,0 +1,47 @@
+import eslintJS from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
+import eslintPluginVue from 'eslint-plugin-vue';
+import typescriptEslint from 'typescript-eslint';
+import eslintConfigPrettier from 'eslint-config-prettier';
+
+const vueFilesConfig = {
+                    name: 'eslint-config-seyrinian-tools/vue',
+                    extends: [...eslintPluginVue.configs['flat/recommended']],
+                    files: ['**/*.{ts,vue}'],
+                    languageOptions: {
+                                        ecmaVersion: 'latest',
+                                        sourceType: 'module',
+                                        globals: globals.browser,
+                                        parserOptions: {
+                                                            parser: typescriptEslint.parser,
+                                        },
+                    },
+                    rules: {},
+};
+
+const defaultConfig = {
+                    name: 'eslint-config-seyrinian-tools/default',
+                    languageOptions: {
+                                        globals: {
+                                                            ...globals.node,
+                                        },
+                    },
+                    rules: {
+                                        'no-console': 'error',
+                                        'no-debugger': 'error',
+                    },
+};
+
+export default tseslint.config(
+                    eslintJS.configs.recommended,
+                    ...tseslint.configs.recommended,
+                    ...tseslint.configs.strict,
+                    ...tseslint.configs.stylistic,
+                    vueFilesConfig,
+                    defaultConfig,
+                    eslintConfigPrettier,
+                    {
+                                        ignores: ['node_modules', 'dist/'],
+                    },
+);

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "@vfourny/node-toolkit",
+  "version": "1.0.1",
+  "description": "",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "private": false,
+  "scripts": {
+    "build": "tsc",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix .",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "type-check": "tsc --noEmit",
+    "prepare": "husky"
+  },
+  "files": [
+    "tsconfig.json",
+    ".commitlintrc.js",
+    "release.config.js",
+    "eslint.config.js",
+    "prettier.config.js"
+  ],
+  "exports": {
+    "./eslint": "./eslint.config.js",
+    "./prettier": "./prettier.config.js",
+    "./commitlint": "./.commitlintrc.js",
+    "./tsconfig": "./tsconfig.json",
+    "./release": "./release.config.js"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@commitlint/config-angular": "^19.3.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-plugin-vue": "^9.32.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.3.0",
+    "@eslint/js": "^9.4.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.0.0",
+    "conventional-changelog-conventionalcommits": "^8.0.0",
+    "eslint": "^9.3.0",
+    "globals": "^15.3.0",
+    "husky": "^9.0.11",
+    "prettier": "^3.2.5",
+    "semantic-release": "^24.0.0",
+    "typescript": "^5.4.5",
+    "typescript-eslint": "^8.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vfourny/node-toolkit.git"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "engines": {
+    "node": ">=20.13 <23",
+    "npm": ">= 10"
+  }
+}

package/prettier.config.js

@@ -0,0 +1,10 @@
+export default {
+  quotes: true,
+  trailingComma: "all",
+  semi: false,
+  printWidth: 80,
+  tabWidth: 2,
+  bracketSpacing: true,
+  bracketLine: false,
+  arrowParens: "always",
+}

package/release.config.js

@@ -0,0 +1,27 @@
+export default {
+  branches: ['main'],
+  plugins: [
+    '@semantic-release/commit-analyzer',
+    '@semantic-release/release-notes-generator',
+    [
+      '@semantic-release/changelog',
+      {
+        changelogFile: 'docs/CHANGELOG.md',
+      },
+    ],
+    '@semantic-release/github',
+    [
+      '@semantic-release/npm',
+      {
+        npmPublish: process.env.PUBLISH === 'true',
+        pkgRoot: '.',
+      },
+    ],
+    [
+      '@semantic-release/git',
+      {
+        assets: ['docs/CHANGELOG.md', 'package.json', 'package-lock.json'],
+      },
+    ],
+  ],
+};

package/tsconfig.json

@@ -0,0 +1,113 @@
+{
+  "exclude": ["node_modules", "dist"],
+  "include": ["src/**/*.ts"],
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    "tsBuildInfoFile": "${configDir}/.cache/.tsbuildinfo" /* Specify the path to .tsbuildinfo incremental compilation file. */,
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "ES6" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "NodeNext" /* Specify what module code is generated. */,
+    // "rootDir": "src" /* Specify the root folder within your source files. */,
+    "moduleResolution": "nodenext" /* Specify how TypeScript looks up a file from a given module specifier. */,
+    // "baseUrl": "."                                    /* Specify the base directory to resolve non-relative module names. */,
+    // "paths": {}                                       /* Specify a set of entries that re-map imports to additional lookup locations. */,
+    // "rootDirs": []                                    /* Allow multiple folders to be treated as one when resolving modules. */,
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    "resolveJsonModule": true /* Enable importing .json files. */,
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    "allowJs": true /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */,
+    "checkJs": true /* Enable error reporting in type-checked JavaScript files. */,
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true /* Generate .d.ts files from TypeScript and JavaScript files in your project. */,
+    // "declarationMap": true /* Create sourcemaps for d.ts files. */,
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./" /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */,
+    "outDir": "${configDir}/dist" /* Specify an output folder for all emitted files. */,
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    "noEmitOnError": true /* Disable emitting files if any type checking errors are reported. */,
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./dist/types" /* Specify the output directory for generated declaration files. */,
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* 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. */
+    // "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": false,             /* Ensure that the return type of generators and async functions are correctly constrained. */
+    // "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. */,
+    "noUncheckedSideEffectImports": true /* Enable error reporting for imports that may be converted to a 'require' call. */,
+    // "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": true /* Disable error reporting for unreachable code. */,
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}