@adbayb/stack 0.0.0-next-84ccbde → 0.0.0-next-a8b5c70

package/README.md

@@ -13,7 +13,7 @@
 - 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, ESLint, Prettier, EditorConfig, Renovate, Changesets, and VSCode)
+- Built-in configuration preset setup (including Node/NPM runtime, Git ignore/hooks, [TypeScript](./config/typescript/), [ESLint](./config/eslint), [Prettier](./config/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)
 
@@ -85,7 +85,7 @@ flowchart TD
 
 - [Commits](https://www.conventionalcommits.org/)
 - [Scripts](https://conventionalscripts.org/)
-- [File Structure](https://nx.dev/concepts/more-concepts/folder-structure)
+- [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

package/dist/index.mjs

@@ -1,7 +1,8 @@
 import { helpers, termost } from 'termost';
 import { existsSync, readdirSync, cpSync, readFileSync, renameSync, writeFileSync } from 'node:fs';
 import { createRequire } from 'node:module';
-import { resolve } from 'node:path';
+import { resolve, join } from 'node:path';
+import process from 'node:process';
 import { fdir } from 'fdir';
 import { mkdir, symlink, writeFile, chmod } from 'node:fs/promises';
 
@@ -51,7 +52,7 @@ ${input.body}
  * @example
  * resolveFromStackDirectory("./templates");
  */ const resolveFromStackDirectory = (path)=>{
-    return resolve(__dirname, "../", path);
+    return resolve(import.meta.dirname, "../", path);
 };
 const getNpmVersion = async ()=>{
     try {
@@ -326,106 +327,9 @@ const PRESERVE_FILES = [
     ".turbo"
 ];
 
-var name = "@adbayb/stack";
-var version = "0.0.0-next-84ccbde";
-var description = "My opinionated JavaScript-based toolchain";
-var publishConfig = {
-	access: "public"
-};
-var files = [
-	"bin",
-	"config",
-	"dist",
-	"template"
-];
-var bin = {
-	stack: "./bin/index.mjs"
-};
-var type = "module";
-var exports = {
-	".": {
-		source: "./src/index.ts",
-		"default": "./dist/index.mjs"
-	},
-	"./eslint": "./config/eslint/index.mjs",
-	"./prettier": "./config/prettier/index.mjs",
-	"./typescript": "./config/typescript/base.json",
-	"./typescript/react": "./config/typescript/react.json"
-};
-var scripts = {
-	prepublishOnly: "pnpm build",
-	prestart: "echo 'prestart'",
-	start: "./bin/index.mjs",
-	build: "quickbundle build",
-	watch: "quickbundle watch"
-};
-var keywords = [
-	"stack",
-	"scripts",
-	"toolchain",
-	"development"
-];
-var author = {
-	name: "Ayoub Adib",
-	email: "adbayb@gmail.com",
-	url: "https://twitter.com/adbayb"
-};
-var repository = {
-	type: "git",
-	url: "https://github.com/adbayb/stack.git",
-	directory: "applications/stack"
-};
-var license = "MIT";
-var devDependencies = {
-	"@types/node": "20.16.12",
-	"@types/eslint-config-prettier": "6.11.3",
-	quickbundle: "2.5.0"
-};
-var dependencies = {
-	"@changesets/changelog-github": "^0.5.0",
-	"@changesets/cli": "^2.27.9",
-	"@commitlint/cli": "^19.5.0",
-	"@commitlint/config-conventional": "^19.5.0",
-	"@eslint/compat": "^1.2.1",
-	"@eslint/eslintrc": "^3.1.0",
-	"@vitest/eslint-plugin": "^1.1.7",
-	eslint: "^9.13.0",
-	"eslint-plugin-react": "^7.37.2",
-	globals: "^15.11.0",
-	"typescript-eslint": "^8.11.0",
-	"eslint-config-prettier": "^9.1.0",
-	"eslint-import-resolver-typescript": "^3.6.3",
-	"eslint-plugin-import": "^2.31.0",
-	"eslint-plugin-jest-formatting": "^3.1.0",
-	"eslint-plugin-jsdoc": "^50.4.3",
-	"eslint-plugin-mdx": "^3.1.5",
-	"eslint-plugin-prettier": "^5.2.1",
-	"eslint-plugin-react-hooks": "^5.0.0",
-	"eslint-plugin-sonarjs": "^2.0.4",
-	"eslint-plugin-sort-keys-custom-order": "^2.2.0",
-	fdir: "^6.4.2",
-	prettier: "^3.3.3",
-	termost: "^0.17.0",
-	turbo: "^2.2.3",
-	typescript: "^5.6.3"
-};
-var pkg = {
-	name: name,
-	version: version,
-	description: description,
-	publishConfig: publishConfig,
-	files: files,
-	bin: bin,
-	type: type,
-	exports: exports,
-	scripts: scripts,
-	keywords: keywords,
-	author: author,
-	repository: repository,
-	license: license,
-	devDependencies: devDependencies,
-	dependencies: dependencies
-};
+var version = "0.0.0-next-a8b5c70";
+
+const VERSION = version;
 
 const createCreateCommand = (program)=>{
     program.command({
@@ -434,7 +338,7 @@ const createCreateCommand = (program)=>{
     }).task({
         handler () {
             botMessage({
-                title: `I'm Stack v${pkg.version}, your bot assistant`,
+                title: `I'm Stack v${VERSION}, your bot assistant`,
                 description: "I can guarantee you a project creation in under 1 minute 🚀"
             }, {
                 type: "information"
@@ -451,7 +355,17 @@ const createCreateCommand = (program)=>{
     }).input({
         key: "inputUrl",
         label: "Where will it be stored? (Git remote URL)",
+        defaultValue: "git@github.com:adbayb/stack.git",
         type: "text"
+    }).input({
+        key: "inputTemplate",
+        label: "Which template you would like to apply?",
+        defaultValue: "single-project",
+        options: [
+            "single-project",
+            "multi-projects"
+        ],
+        type: "select"
     }).task({
         label: label$2("Checking pre-requisites"),
         async handler () {
@@ -495,8 +409,8 @@ const createCreateCommand = (program)=>{
         }
     }).task({
         label: label$2("Applying template"),
-        handler ({ data }) {
-            applyTemplate(data);
+        handler ({ data, inputTemplate }) {
+            applyTemplate(inputTemplate, data);
         }
     }).task({
         label: label$2("Installing dependencies"),
@@ -558,14 +472,15 @@ const createCreateCommand = (program)=>{
 const label$2 = (message)=>`${message} 🔨`;
 /**
  * A simple template engine to evaluate dynamic expressions and apply side effets (such as hydrating a content with values from an input object) on impacted template files.
+ * @param template - The selected template.
  * @param dataModel - Data model mapping the template expression key with its corresponding value.
  * @example
  * applyTemplate(
  * 	{ toReplace: "value" },
  * );
- */ const applyTemplate = (dataModel)=>{
+ */ const applyTemplate = (template, dataModel)=>{
     const templateExtension = ".tmpl";
-    const templateRootPath = resolveFromStackDirectory("./template");
+    const templateRootPath = resolveFromStackDirectory(join("./templates", template));
     const projectRootPath = resolveFromProjectDirectory("./");
     const templateExpressionRegExp = /{{(.*?)}}/g;
     const evaluate = (content)=>{
@@ -716,7 +631,8 @@ const createWatchCommand = (program)=>{
 const createProgram = (...commandFactories)=>{
     const program = termost({
         name: "stack",
-        description: "Toolbox to easily scaffold and maintain a project"
+        description: "Toolbox to easily scaffold and maintain a project",
+        version: VERSION
     });
     for (const commandBuilder of commandFactories){
         commandBuilder(program);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adbayb/stack",
-  "version": "0.0.0-next-84ccbde",
+  "version": "0.0.0-next-a8b5c70",
   "description": "My opinionated JavaScript-based toolchain",
   "publishConfig": {
     "access": "public"
@@ -9,7 +9,7 @@
     "bin",
     "config",
     "dist",
-    "template"
+    "templates"
   ],
   "bin": {
     "stack": "./bin/index.mjs"
@@ -76,7 +76,7 @@
     "typescript": "^5.6.3"
   },
   "scripts": {
-    "prestart": "echo 'prestart'",
+    "prestart": "pnpm build",
     "start": "./bin/index.mjs",
     "build": "quickbundle build",
     "watch": "quickbundle watch"

package/{template → templates/multi-projects}/.editorconfig

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

package/templates/multi-projects/applications/README.md

@@ -0,0 +1,6 @@
+# Applications
+
+> [!note]
+> Optional folder that can be removed if there is no planned use case.
+
+A collection of application-like projects. An application is a runnable program (a command-line interface, a mobile/web application, ...).

package/{template → templates/multi-projects}/libraries/README.md

@@ -1,9 +1,3 @@
 # Libraries
 
-> [!note]
-> Optional folder that can be either:
->
-> - Kept if the root package needs to be moved into it (when several package types (applications, libraries, ...) need to be created and the root package is by its nature a library)
-> - Otherwise, removed if no planned use case
-
 A collection of internal and/or publishable libraries (referred to as packages in the Node ecosystem) that are leveraged during software development to implement/share a specific aspect/functionality. A library generally encapsulates highly cohesive modules together.

package/templates/multi-projects/libraries/{{projectName}}/package.json.tmpl

@@ -0,0 +1,39 @@
+{
+	"name": "{{projectName}}",
+	"description": "{{projectDescription}}",
+	"version": "0.0.0",
+	"publishConfig": {
+		"access": "public"
+	},
+	"files": [
+		"dist"
+	],
+	"sideEffects": false,
+	"type": "module",
+	"exports": {
+		".": {
+			"source": "./src/index.ts",
+			"types": "./dist/index.d.ts",
+			"require": "./dist/index.cjs",
+			"import": "./dist/index.mjs",
+			"default": "./dist/index.mjs"
+		}
+	},
+	"license": "MIT",
+	"author": "Ayoub Adib <adbayb@gmail.com> (https://twitter.com/adbayb)",
+	"bugs": "https://github.com/{{repoId}}/issues",
+	"homepage": "https://github.com/{{repoId}}/tree/main/{{projectName}}#readme",
+	"repository": {
+		"type": "git",
+		"url": "{{projectUrl}}",
+		"directory": "libraries/{{projectName}}"
+	},
+	"scripts": {
+		"prepublishOnly": "pnpm build",
+		"clean": "rm -rf dist",
+		"start": "pnpm watch",
+		"build": "pnpm clean && quickbundle build",
+		"watch": "quickbundle watch",
+		"test": "vitest"
+	}
+}

package/templates/multi-projects/libraries/{{projectName}}/tsconfig.json

@@ -0,0 +1,5 @@
+{
+	"extends": "../../tsconfig.json",
+	"include": ["src"],
+	"exclude": ["node_modules", "dist"]
+}

package/{template → templates/multi-projects}/pnpm-workspace.yaml.tmpl

@@ -3,4 +3,3 @@ packages:
     - "examples/*"
     - "libraries/*"
     - "tools/*"
-    - "{{projectName}}"

package/templates/single-project/.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/templates/single-project/.changeset/config.json.tmpl

@@ -0,0 +1,13 @@
+{
+	"$schema": "https://raw.githubusercontent.com/changesets/changesets/main/packages/config/schema.json",
+	"access": "public",
+	"baseBranch": "main",
+	"changelog": ["@changesets/changelog-github", { "repo": "{{repoId}}" }],
+	"commit": false,
+	"ignore": ["@examples/*"],
+	"updateInternalDependencies": "patch",
+	"___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+		"onlyUpdatePeerDependentsWhenOutOfRange": true,
+		"updateInternalDependents": "out-of-range"
+	}
+}

package/templates/single-project/.changeset/welcome.md.tmpl

@@ -0,0 +1,5 @@
+---
+"{{projectName}}": minor
+---
+
+v0.1.0 release 🚀

package/templates/single-project/.commitlintrc.json

@@ -0,0 +1,3 @@
+{
+	"extends": ["@commitlint/config-conventional"]
+}

package/templates/single-project/.editorconfig

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

package/templates/single-project/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,34 @@
+---
+name: "🐛 Bug Report"
+about: Report a reproducible bug or regression.
+title: "Bug: "
+labels: ["bug", "triage"]
+---
+
+## Description
+
+<!--
+  Please provide a clear and concise description of what the bug is with the current and expected behavior(s). Include
+  screenshots if needed. Please test using the latest version of the relevant package to make sure your issue has not already been fixed.
+-->
+
+## Reproduction
+
+<!--
+  Issues without reproduction steps or code examples may be immediately closed as not actionable. Your bug will get fixed much faster if we can run your code. You may provide a screenshot of the application if you think it is relevant to your bug report. Here are some tips for providing a minimal example: https://stackoverflow.com/help/mcve.
+-->
+
+## Environment
+
+<!--
+  Please provide the environment you discovered this bug in.
+  It must include following informations:
+    - OS [eg. Android, iOS, mac OS, Windows, ...]
+    - Browser [eg. Chrome@110, Safari@16, ...]
+-->
+
+## Additional context
+
+<!--
+  Add any other context about the problem (eg. issue URL, related issues, documentation, etc...)
+-->

package/templates/single-project/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +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.

package/templates/single-project/.github/PULL_REQUEST_TEMPLATE.md.tmpl

@@ -0,0 +1,29 @@
+<!--
+  Thanks for submitting a pull request!
+  We appreciate you spending the time to work on these changes. Before requesting reviews, please make sure that:
+
+  1. Your contribution follows coding conventions
+  2. Some valuable tests have been added
+  3. For non-internal change, a changelog entry is added
+
+  Learn more about contributing [here](https://github.com/{{repoId}}/blob/main/CONTRIBUTING.md)
+-->
+
+## Description
+
+Please include a concise summary of the change with the relevant context and main highlights:
+
+-   [ ] What I've done 1
+-   [ ] What I've done 2...
+
+## Screenshots
+
+| Before | After |
+| ------ | ----- |
+| Image  | Image |
+
+## Resources
+
+-   Issue (GitHub, ...)
+-   Specification (ADRs, RFCs, ...)
+-   ...

package/templates/single-project/.github/renovate.json

@@ -0,0 +1,69 @@
+{
+	"$schema": "https://docs.renovatebot.com/renovate-schema.json",
+	"extends": [
+		":automergeAll",
+		":automergePr",
+		":automergeRequireAllStatusChecks",
+		":enableVulnerabilityAlerts",
+		":label(dependencies)",
+		":maintainLockFilesMonthly",
+		":prConcurrentLimit10",
+		":rebaseStalePrs",
+		":semanticCommits",
+		":semanticCommitScopeDisabled",
+		":semanticPrefixFixDepsChoreOthers",
+		":timezone(Europe/Paris)",
+		"npm:unpublishSafe",
+		"replacements:all",
+		"schedule:monthly",
+		"workarounds:all"
+	],
+	"commitBodyTable": true,
+	"platformAutomerge": false,
+	"ignoreDeps": [],
+	"packageRules": [
+		{
+			"matchPackagePatterns": ["*"],
+			"rangeStrategy": "auto"
+		},
+		{
+			"matchDepTypes": ["devDependencies"],
+			"rangeStrategy": "pin"
+		},
+		{
+			"matchDepTypes": ["dependencies"],
+			"rangeStrategy": "bump"
+		},
+		{
+			"description": "Synchronize CircleCI Docker image version with the Node.js one",
+			"matchPackageNames": ["cimg/node"],
+			"versioning": "node"
+		},
+		{
+			"groupName": "package dependencies",
+			"matchManagers": ["npm"],
+			"matchDepTypes": [
+				"dependencies",
+				"devDependencies",
+				"optionalDependencies",
+				"peerDependencies"
+			]
+		},
+		{
+			"groupName": "infrastructure dependencies",
+			"matchManagers": [
+				"circleci",
+				"github-actions",
+				"dockerfile",
+				"terraform",
+				"terraform-version",
+				"docker-compose",
+				"kubernetes"
+			]
+		},
+		{
+			"groupName": "engine dependencies",
+			"matchPackagePatterns": ["node", "pnpm"]
+		}
+	]
+}

package/templates/single-project/.github/workflows/continuous_delivery.yml

@@ -0,0 +1,53 @@
+name: Continous delivery
+
+on:
+  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)
+        run: |
+          pnpm --recursive exec pnpm version "$(pnpm show ./ version)-next-${GITHUB_SHA::7}"
+          pnpm --recursive exec pnpm publish --tag next --no-git-checks
+      - name: Prepare or Publish stable version(s)
+        uses: changesets/action@v1
+        with:
+          commit: "chore: release package(s)"
+          title: "chore: release package(s)"
+          version: pnpm release:version
+          publish: pnpm release:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/templates/single-project/.github/workflows/continuous_integration.yml

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

package/templates/single-project/.github/workflows/conventional_commit.yml

@@ -0,0 +1,48 @@
+name: Conventional commit
+
+on:
+  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