@adbayb/stack 2.6.2 → 2.8.0

package/README.md

@@ -9,13 +9,13 @@
 
 `Stack` allows creating an NPM project in a **quick**, **easy** and **opinionated** way with:
 
-- A unified monorepo-driven and git-driven approach for all kinds of projects (single-purpose library, multiple libraries, application(s), ...)
-- Support for several application templates (for now, only a default template is available, but others can be added later)
-- Standardized file structure including optional folder creation such as `examples`, `packages`, ...
-- Enable all project lifecycle steps with commands from the setup, check, fix, build, and test to the versioning and release
-- Built-in configuration preset setup (including Node/NPM runtime, Git ignore/hooks, [TypeScript](https://github.com/adbayb/stack/blob/main/stack/configs/typescript/), [ESLint](https://github.com/adbayb/stack/blob/main/stack/configs/eslint/), [Prettier](https://github.com/adbayb/stack/blob/main/stack/configs/prettier/), EditorConfig, Renovate, Changesets, and VSCode)
-- A welcoming environment for users and contributors with the continuous integration setup, and the creation of `README.md`, `CONTRIBUTING.md`, and GitHub template files (including issue and pull request ones), ...
-- An optimized development environment with command caching (no build needed if nothing changes)
+-   A unified monorepo-driven and git-driven approach for all kinds of projects (single-purpose library, multiple libraries, application(s), ...)
+-   Support for several application templates (for now, only a default template is available, but others can be added later)
+-   Standardized file structure including optional folder creation such as `examples`, `packages`, ...
+-   Enable all project lifecycle steps with commands from the setup, check, fix, build, and test to the versioning and release
+-   Built-in configuration preset setup (including Node/NPM runtime, Git ignore/hooks, [TypeScript](https://github.com/adbayb/stack/blob/main/stack/configs/typescript/), [ESLint](https://github.com/adbayb/stack/blob/main/stack/configs/eslint/), [Prettier](https://github.com/adbayb/stack/blob/main/stack/configs/prettier/), EditorConfig, Renovate, Changesets, and VSCode)
+-   A welcoming environment for users and contributors with the continuous integration setup, and the creation of `README.md`, `CONTRIBUTING.md`, and GitHub template files (including issue and pull request ones), ...
+-   An optimized development environment with command caching (no build needed if nothing changes)
 
 <br>
 
@@ -63,27 +63,27 @@ stack release
 
 ### Available configurations
 
-- [@adbayb/stack/eslint](https://github.com/adbayb/stack/blob/main/stack/configs/eslint/) to align logical and stylistic rules across projects.
-- [@adbayb/stack/prettier](https://github.com/adbayb/stack/blob/main/stack/configs/prettier/) to align code formatting conventions across projects.
-- [@adbayb/stack/typescript](https://github.com/adbayb/stack/blob/main/stack/configs/typescript/) to align type checking and processing across projects.
+-   [@adbayb/stack/eslint](https://github.com/adbayb/stack/blob/main/stack/configs/eslint/) to align logical and stylistic rules across projects.
+-   [@adbayb/stack/prettier](https://github.com/adbayb/stack/blob/main/stack/configs/prettier/) to align code formatting conventions across projects.
+-   [@adbayb/stack/typescript](https://github.com/adbayb/stack/blob/main/stack/configs/typescript/) to align type checking and processing across projects.
 
 ### Used technologies
 
-- **Static code analysis**: ESLint, Prettier
-- **Node package manager**: PNPM
-- **Task orchestration**: Turborepo
-- **Release**: Changesets
-- **Testing**: Vitest
+-   **Static code analysis**: ESLint, Prettier
+-   **Node package manager**: PNPM
+-   **Task orchestration**: Turborepo
+-   **Release**: Changesets
+-   **Testing**: Vitest
 
 ### Used conventions
 
-- [Commits](https://www.conventionalcommits.org/)
-- [Scripts](https://conventionalscripts.org/)
-- [File Structure](https://nx.dev/concepts/decisions/folder-structure)
-  - Monorepo-first structure to:
-    - Keep a consistent file structure pattern across templates (ease template familiarity and onboarding).
-    - Ease examples setup.
-    - Not clutter the published package with development-related context, metadata, and artifacts.
+-   [Commits](https://www.conventionalcommits.org/)
+-   [Scripts](https://conventionalscripts.org/)
+-   [File Structure](https://nx.dev/concepts/decisions/folder-structure)
+    -   Monorepo-first structure to:
+        -   Keep a consistent file structure pattern across templates (ease template familiarity and onboarding).
+        -   Ease examples setup.
+        -   Not clutter the published package with development-related context, metadata, and artifacts.
 
 <br>
 

package/configs/eslint/README.md

@@ -12,9 +12,9 @@ This package offers opinionated but extensible **[ESLint](https://eslint.org/)**
 
 It allows to:
 
-- Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
-- Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
-- Accelerate development by reusing common configuration and convention defaults.
+-   Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
+-   Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
+-   Accelerate development by reusing common configuration and convention defaults.
 
 <br />
 

package/configs/eslint/presets/import.js

@@ -10,7 +10,10 @@ export const config = [
 			"import-x": importPlugin,
 		},
 		rules: {
-			"import-x/consistent-type-specifier-style": ["error", "prefer-top-level"],
+			"import-x/consistent-type-specifier-style": [
+				"error",
+				"prefer-top-level",
+			],
 			"import-x/export": "error",
 			"import-x/first": "error",
 			"import-x/newline-after-import": "error",

package/configs/eslint/presets/react.js

@@ -15,7 +15,8 @@ export const config = [
 		},
 		rules: {
 			"react-hooks-extra/no-direct-set-state-in-use-effect": "error",
-			"react-hooks-extra/no-direct-set-state-in-use-layout-effect": "error",
+			"react-hooks-extra/no-direct-set-state-in-use-layout-effect":
+				"error",
 			"react-hooks-extra/no-redundant-custom-hook": "error",
 			"react-hooks-extra/no-unnecessary-use-callback": "error",
 			"react-hooks-extra/no-unnecessary-use-memo": "error",

package/configs/eslint/presets/test.js

@@ -48,12 +48,16 @@ export const config = [
 			"vitest/prefer-to-have-length": "error",
 			"vitest/prefer-todo": "error",
 			"vitest/require-hook": "error",
-			"vitest/require-local-test-context-for-concurrent-snapshots": "error",
+			"vitest/require-local-test-context-for-concurrent-snapshots":
+				"error",
 			"vitest/require-to-throw-message": "error",
 			"vitest/require-top-level-describe": "error",
 			"vitest/valid-describe-callback": "error",
 			"vitest/valid-expect": "error",
-			"vitest/valid-title": ["error", { mustMatch: { test: ["^should "] } }],
+			"vitest/valid-title": [
+				"error",
+				{ mustMatch: { test: ["^should "] } },
+			],
 		},
 	},
 ];

package/configs/eslint/presets/typescript.js

@@ -38,13 +38,19 @@ export const config = [
 				},
 			],
 			"@typescript-eslint/ban-tslint-comment": "error",
-			"@typescript-eslint/class-literal-property-style": ["error", "fields"],
+			"@typescript-eslint/class-literal-property-style": [
+				"error",
+				"fields",
+			],
 			"@typescript-eslint/class-methods-use-this": "error",
 			"@typescript-eslint/consistent-generic-constructors": [
 				"error",
 				"constructor",
 			],
-			"@typescript-eslint/consistent-indexed-object-style": ["error", "record"],
+			"@typescript-eslint/consistent-indexed-object-style": [
+				"error",
+				"record",
+			],
 			"@typescript-eslint/consistent-type-assertions": [
 				"error",
 				{
@@ -105,14 +111,16 @@ export const config = [
 			"@typescript-eslint/no-misused-promises": "error",
 			"@typescript-eslint/no-mixed-enums": "error",
 			"@typescript-eslint/no-namespace": "error",
-			"@typescript-eslint/no-non-null-asserted-nullish-coalescing": "error",
+			"@typescript-eslint/no-non-null-asserted-nullish-coalescing":
+				"error",
 			"@typescript-eslint/no-non-null-asserted-optional-chain": "error",
 			"@typescript-eslint/no-non-null-assertion": "error",
 			"@typescript-eslint/no-redundant-type-constituents": "error",
 			"@typescript-eslint/no-require-imports": "error",
 			"@typescript-eslint/no-shadow": "error",
 			"@typescript-eslint/no-this-alias": "error",
-			"@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
+			"@typescript-eslint/no-unnecessary-boolean-literal-compare":
+				"error",
 			"@typescript-eslint/no-unnecessary-condition": "error",
 			"@typescript-eslint/no-unnecessary-qualifier": "error",
 			"@typescript-eslint/no-unnecessary-template-expression": "error",
@@ -170,7 +178,8 @@ export const config = [
 			"@typescript-eslint/triple-slash-reference": "error",
 			"@typescript-eslint/unbound-method": "error",
 			"@typescript-eslint/unified-signatures": "error",
-			"@typescript-eslint/use-unknown-in-catch-callback-variable": "error",
+			"@typescript-eslint/use-unknown-in-catch-callback-variable":
+				"error",
 		},
 	},
 	{

package/configs/eslint/presets/uncategorized.js

@@ -16,13 +16,27 @@ export const config = [
 			"sort-keys-custom-order/object-keys": [
 				"error",
 				{
-					orderedKeys: ["id", "key", "name", "title", "label", "description"],
+					orderedKeys: [
+						"id",
+						"key",
+						"name",
+						"title",
+						"label",
+						"description",
+					],
 				},
 			],
 			"sort-keys-custom-order/type-keys": [
 				"error",
 				{
-					orderedKeys: ["id", "key", "name", "title", "label", "description"],
+					orderedKeys: [
+						"id",
+						"key",
+						"name",
+						"title",
+						"label",
+						"description",
+					],
 				},
 			],
 		},

package/configs/eslint/presets/unicorn.js

@@ -76,7 +76,10 @@ export const config = [
 			"unicorn/prefer-dom-node-remove": "error",
 			"unicorn/prefer-dom-node-text-content": "error",
 			"unicorn/prefer-event-target": "error",
-			"unicorn/prefer-export-from": ["error", { ignoreUsedVariables: true }],
+			"unicorn/prefer-export-from": [
+				"error",
+				{ ignoreUsedVariables: true },
+			],
 			"unicorn/prefer-global-this": "error",
 			"unicorn/prefer-includes": "error",
 			"unicorn/prefer-keyboard-event-key": "error",

package/configs/prettier/README.md

@@ -12,9 +12,9 @@ This package offers opinionated but extensible **[Prettier](https://prettier.io/
 
 It allows to:
 
-- Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
-- Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
-- Accelerate development by reusing common configuration and convention defaults.
+-   Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
+-   Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
+-   Accelerate development by reusing common configuration and convention defaults.
 
 <br />
 
@@ -52,8 +52,8 @@ Edit the root `package.json` file to include the following:
 
 If you feel that tabbed indentation rendered on the GitHub web interface takes up too much (by default, most browsers display a tab character as 8 spaces), you can either:
 
-- Edit your [GitHub profile appearance settings](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference).
-- Add (or update) a `.editorconfig` file at the root level to customize the tab size display on the GitHub interface.
+-   Edit your [GitHub profile appearance settings](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-tab-size-rendering-preference).
+-   Add (or update) a `.editorconfig` file at the root level to customize the tab size display on the GitHub interface.
 
 ```yaml
 root = true

package/configs/prettier/index.js

@@ -18,7 +18,7 @@ export default {
 	semi: true,
 	singleAttributePerLine: true,
 	singleQuote: false,
-	tabWidth: 2,
+	tabWidth: 4,
 	trailingComma: "all",
 	useTabs: true,
 	vueIndentScriptAndStyle: false,

package/configs/typescript/README.md

@@ -12,9 +12,9 @@ This package offers opinionated but extensible **[TypeScript](https://www.typesc
 
 It allows to:
 
-- Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
-- Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
-- Accelerate development by reusing common configuration and convention defaults.
+-   Make collaboration across my projects effective (including onboarding with a consistent look and writing patterns).
+-   Include a minimum viable and required set of rules to foster maintainable, testable, secure, and green code over time.
+-   Accelerate development by reusing common configuration and convention defaults.
 
 <br />
 

package/dist/index.js

@@ -186,7 +186,7 @@ const ESLINT_EXTENSIONS = [
     "mdx"
 ];
 
-var version = "2.6.2";
+var version = "2.8.0";
 
 const createWatchCommand = (program)=>{
     program.command({
@@ -291,7 +291,6 @@ const fixLinter = eslint({
 });
 
 const PRETTIER_IGNORE_FILES = [
-    "CHANGELOG.md",
     "pnpm-lock.yaml"
 ];
 const fixFormatting = async (files)=>{
@@ -300,8 +299,7 @@ const fixFormatting = async (files)=>{
         prettierFiles.push(`"**/!(${PRETTIER_IGNORE_FILES.join("|")})"`);
     } else {
         prettierFiles = files.filter((file)=>{
-            return !PRETTIER_IGNORE_FILES.some((filename)=>file.endsWith(filename)) && // The root `README.md` file is ignored to prevent error due to its symbolic link nature when specified explicitly as a file
-            file !== "README.md";
+            return !PRETTIER_IGNORE_FILES.some((filename)=>file.endsWith(filename));
         });
         if (prettierFiles.length === 0) return;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adbayb/stack",
-  "version": "2.6.2",
+  "version": "2.8.0",
   "description": "My opinionated JavaScript-based toolchain",
   "publishConfig": {
     "access": "public"

package/templates/multi-projects/.editorconfig

@@ -1,4 +1,4 @@
 root = true
 
 [*]
-indent_size = 2
+indent_size = 4

package/templates/multi-projects/.github/ISSUE_TEMPLATE/config.yml

@@ -1,4 +1,4 @@
 blank_issues_enabled: false
 contact_links:
-  - name: 🤔 Questions and Help
-    about: Issues are dedicated to bugs, if you have any question, please use the dedicated GitHub discussion category.
+    - name: 🤔 Questions and Help
+      about: Issues are dedicated to bugs, if you have any question, please use the dedicated GitHub discussion category.

package/templates/multi-projects/.github/workflows/continuous_delivery.yml

@@ -1,61 +1,61 @@
 name: Continous delivery
 
 on:
-  push:
-    branches:
-      - main
+    push:
+        branches:
+            - main
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
 jobs:
-  integrate:
-    uses: ./.github/workflows/workflow.yml
-  release:
-    timeout-minutes: 5
-    needs: integrate
-    runs-on: ubuntu-latest
-    permissions:
-      contents: write
-      pull-requests: write
-    steps:
-      - uses: actions/checkout@v4
-      - uses: pnpm/action-setup@v4
-      - name: Get node version
-        run: echo "version=$(cat .nvmrc)" >> $GITHUB_OUTPUT
-        id: node
-      - name: Setup node ${{ steps.node.outputs.version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ steps.node.outputs.version }}
-          cache: pnpm
-      - name: Setup .npmrc
-        run: |
-          cat << EOF > "$HOME/.npmrc"
-            //registry.npmjs.org/:_authToken=$NPM_TOKEN
-          EOF
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile
-      - name: Publish pre-release version(s)
-        if: "!contains(github.event.head_commit.message, 'chore: release package(s)')"
-        run: |
-          pnpm --filter=\!@examples/\* --recursive exec pnpm version "$(pnpm show ./ version)-next-${GITHUB_SHA::7}"
-          pnpm --filter=\!@examples/\* --recursive exec pnpm publish --tag next --no-git-checks
-      - name: Create release pull request
-        if: "!contains(github.event.head_commit.message, 'chore: release package(s)')"
-        uses: changesets/action@v1
-        with:
-          commit: "chore: release package(s)"
-          title: "chore: release package(s)"
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      - name: Publish stable version(s)
-        if: "contains(github.event.head_commit.message, 'chore: release package(s)')"
-        uses: changesets/action@v1
-        with:
-          version: pnpm release:version
-          publish: pnpm release:publish
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+    integrate:
+        uses: ./.github/workflows/workflow.yml
+    release:
+        timeout-minutes: 5
+        needs: integrate
+        runs-on: ubuntu-latest
+        permissions:
+            contents: write
+            pull-requests: write
+        steps:
+            - uses: actions/checkout@v4
+            - uses: pnpm/action-setup@v4
+            - name: Get node version
+              run: echo "version=$(cat .nvmrc)" >> $GITHUB_OUTPUT
+              id: node
+            - name: Setup node ${{ steps.node.outputs.version }}
+              uses: actions/setup-node@v4
+              with:
+                  node-version: ${{ steps.node.outputs.version }}
+                  cache: pnpm
+            - name: Setup .npmrc
+              run: |
+                  cat << EOF > "$HOME/.npmrc"
+                    //registry.npmjs.org/:_authToken=$NPM_TOKEN
+                  EOF
+              env:
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+            - name: Install dependencies
+              run: pnpm install --frozen-lockfile
+            - name: Publish pre-release version(s)
+              if: "!contains(github.event.head_commit.message, 'chore: release package(s)')"
+              run: |
+                  pnpm --filter=\!@examples/\* --recursive exec pnpm version "$(pnpm show ./ version)-next-${GITHUB_SHA::7}"
+                  pnpm --filter=\!@examples/\* --recursive exec pnpm publish --tag next --no-git-checks
+            - name: Create release pull request
+              if: "!contains(github.event.head_commit.message, 'chore: release package(s)')"
+              uses: changesets/action@v1
+              with:
+                  commit: "chore: release package(s)"
+                  title: "chore: release package(s)"
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+            - name: Publish stable version(s)
+              if: "contains(github.event.head_commit.message, 'chore: release package(s)')"
+              uses: changesets/action@v1
+              with:
+                  version: pnpm release:version
+                  publish: pnpm release:publish
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/templates/multi-projects/.github/workflows/continuous_integration.yml

@@ -1,9 +1,9 @@
 name: Continuous integration
 
 on:
-  push:
-    branches-ignore: main
+    push:
+        branches-ignore: main
 
 jobs:
-  main:
-    uses: ./.github/workflows/workflow.yml
+    main:
+        uses: ./.github/workflows/workflow.yml

package/templates/multi-projects/.github/workflows/conventional_commit.yml

@@ -1,48 +1,48 @@
 name: Conventional commit
 
 on:
-  pull_request:
-    types: [opened, edited]
+    pull_request:
+        types: [opened, edited]
 
 jobs:
-  main:
-    timeout-minutes: 5
-    runs-on: ubuntu-latest
-    steps:
-      - uses: amannn/action-semantic-pull-request@v5
-        id: check_pr_rule
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        with:
-          types: |
-            build
-            chore
-            ci
-            docs
-            feat
-            fix
-            perf
-            refactor
-            revert
-            style
-            test
-          requireScope: false
-          subjectPattern: ^(?![A-Z]).+$
-          subjectPatternError: The subject must start with a lowercase character
-      # Create a sticky comment to display the detailed error
-      - uses: marocchino/sticky-pull-request-comment@v2
-        if: always() && (steps.check_pr_rule.outputs.error_message != null)
-        with:
-          header: check_pr_comment
-          message: |
-            Pull request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/).
-            Please adjust your title following:
-            ```
-            ${{ steps.check_pr_rule.outputs.error_message }}
-            ```
-      # Delete a previous comment when the issue has been resolved
-      - if: ${{ steps.check_pr_rule.outputs.error_message == null }}
-        uses: marocchino/sticky-pull-request-comment@v2
-        with:
-          header: check_pr_comment
-          delete: true
+    main:
+        timeout-minutes: 5
+        runs-on: ubuntu-latest
+        steps:
+            - uses: amannn/action-semantic-pull-request@v5
+              id: check_pr_rule
+              env:
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              with:
+                  types: |
+                      build
+                      chore
+                      ci
+                      docs
+                      feat
+                      fix
+                      perf
+                      refactor
+                      revert
+                      style
+                      test
+                  requireScope: false
+                  subjectPattern: ^(?![A-Z]).+$
+                  subjectPatternError: The subject must start with a lowercase character
+            # Create a sticky comment to display the detailed error
+            - uses: marocchino/sticky-pull-request-comment@v2
+              if: always() && (steps.check_pr_rule.outputs.error_message != null)
+              with:
+                  header: check_pr_comment
+                  message: |
+                      Pull request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/).
+                      Please adjust your title following:
+                      ```
+                      ${{ steps.check_pr_rule.outputs.error_message }}
+                      ```
+            # Delete a previous comment when the issue has been resolved
+            - if: ${{ steps.check_pr_rule.outputs.error_message == null }}
+              uses: marocchino/sticky-pull-request-comment@v2
+              with:
+                  header: check_pr_comment
+                  delete: true