@p8ec/shared 2.2.5 → 2.4.1

package/README.md

@@ -4,7 +4,13 @@ Shared TypeScript/JavaScript libraries for P(8) products.
 
 ## Shared Configuration
 
-Shared configuration for P(8) projects.
+Shared (**and very opinionated**) configuration for P(8) projects.
+
+**Contents:**
+- ESLint configuration
+- Prettier configuration
+- Commitlint configuration
+- Lefthook configuration
 
 ### Usage
 
@@ -23,20 +29,31 @@ p8-cli init
 This command will create the following files in your project and remove corresponding configuration entries
 from `package.json`:
 
-#### **`.eslintrc.js`**
+#### **`.eslintrc.cjs`**
 
 ```javascript 
+/* eslint-disable */
 module.exports = require('@p8ec/shared').eslintConfigRecommended;
 ```
 
-#### **`.prettierrc.js`**
+#### **`.prettierrc.cjs`**
 
 ```javascript 
+/* eslint-disable */
 module.exports = require('@p8ec/shared').prettierConfigRecommended;
 ```
 
+#### **`.commitlintrc.cjs`**
+
+```javascript
+/* eslint-disable */
+module.exports = { extends: ["@commitlint/config-conventional"] };
+```
+
 ## P(8) CLI Tool
 
+A command-line interface (CLI) tool for P(8) projects to simplify common tasks.
+
 ### Syntax
 
 ```shell
@@ -46,6 +63,8 @@ p8-cli [command] [options]
 ### Commands
 
 - `init` - Initialize P(8) shared configuration in your project. Options: `cleanup` - remove configuration entries from `package.json`
+  - Example: `p8-cli init --cleanup` - initializes the shared configuration and removes corresponding entries from `package.json`.
 - `dirn` - Get the directory name. Options: `0` - current directory (default), `1` - parent directory, `2` - 2 levels up
   directory, etc.
+  - Example: `p8-cli dirn 1` - shows the parent directory name.
 

package/dist/assets/lefthook.yml

@@ -1,6 +1,19 @@
-#   Refer for explanation to following link:
+#   Refer for explanation to the following link:
 #   https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md
 
+### Pre-commit hook ###
+# 1. Block commits to main, master, and release branches
+pre-commit:
+  commands:
+    git:
+      run: |
+          if [[ $(git rev-parse --abbrev-ref HEAD) =~ ^(main|master|release)$ ]]; then
+            echo "Direct commits to main, master, and release branches are not allowed."
+            exit 1
+          fi
+
+### Commit message hook ###
+# 1. Allow only commit messages that follow a conventional commit format
 commit-msg:
   commands:
     commitlint:

package/dist/cjs/bin/p8-shared-cli.js

@@ -115,6 +115,8 @@ const init = (option) => __awaiter(void 0, void 0, void 0, function* () {
     copyAsset(`eslint.config.${moduleType}`);
     writeLn(`Creating prettier.config.${moduleType}...`);
     copyAsset(`prettier.config.${moduleType}`);
+    packageJson.scripts['npm:reset'] = 'rm -rf ./**/node_modules && rm -rf ./**/package-lock.json && npm install';
+    packageJson.scripts['npm:audit'] = 'npm audit --audit-level=moderate';
     const lefthook = yield (0, yesno_1.default)({
         question: 'Do you want to use commitlint/lefthook? [y]n',
         defaultValue: true,
@@ -130,10 +132,31 @@ const init = (option) => __awaiter(void 0, void 0, void 0, function* () {
         const lefthookInstall = 'lefthook install';
         packageJson.scripts.postinstall = lefthookInstall;
         const npmInstall = 'npm install --save-dev @commitlint/{config-conventional,cli} commitlint lefthook';
-        writeLn(`Executing ${npmInstall}...`);
-        execShell(npmInstall);
-        writeLn(`Executing ${lefthookInstall}...`);
-        execShell(lefthookInstall);
+        const pnpmInstall = 'pnpm install -D @commitlint/{config-conventional,cli} commitlint lefthook';
+        if (yield (0, yesno_1.default)({
+            question: `Do you want to run "${npmInstall}" now? [y]n`,
+            defaultValue: true,
+            yesValues: ['yes', 'y'],
+            noValues: ['no', 'n'],
+        })) {
+            writeLn(`Executing ${npmInstall}...`);
+            execShell(npmInstall);
+        }
+        else {
+            writeLn('You could run the following command to install needed dependencies:');
+            writeLn(npmInstall);
+            writeLn('Or, for pnpm users:');
+            writeLn(pnpmInstall);
+        }
+        if (yield (0, yesno_1.default)({
+            question: `Do you want to run "${lefthookInstall}" now? [y]n`,
+            defaultValue: true,
+            yesValues: ['yes', 'y'],
+            noValues: ['no', 'n'],
+        })) {
+            writeLn(`Executing ${lefthookInstall}...`);
+            execShell(lefthookInstall);
+        }
     }
     if (option === null || option === void 0 ? void 0 : option.split(',').includes('cleanup')) {
         initCleanup(packageJson);
@@ -153,13 +176,13 @@ const dirn = (levelsUp) => {
     return process.cwd().split(path.sep).reverse()[levels];
 };
 const setup = () => __awaiter(void 0, void 0, void 0, function* () {
-    // Ask user for arguments if IS_DEV is true
+    // Ask the user for arguments if IS_DEV is true
     if (IS_DEV) {
         args = (yield (0, prompt_1.default)('Enter arguments: ')).split(' ');
     }
     switch (args[0]) {
         case 'init':
-            init(args[1]);
+            yield init(args[1]);
             break;
         case 'dirn':
             writeLn(dirn(args[1]));
@@ -169,4 +192,16 @@ const setup = () => __awaiter(void 0, void 0, void 0, function* () {
             process.exit(1);
     }
 });
-setup();
+setup()
+    .then((r) => {
+    if (IS_DEV) {
+        writeLn(`DEV: setup completed with result: ${r}`);
+    }
+})
+    .catch((err) => {
+    if (IS_DEV) {
+        writeLn(`DEV: setup failed with error: ${err}`);
+    }
+    console.error(`Error: ${err}`);
+    process.exit(1);
+});

package/dist/types/prettierConfigRecommended.d.ts

@@ -27,9 +27,10 @@ declare const _default: (overrides?: PrettierConfigOverride) => {
     filepath?: string | undefined;
     requirePragma?: boolean | undefined;
     insertPragma?: boolean | undefined;
+    checkIgnorePragma?: boolean | undefined;
     proseWrap?: "preserve" | "always" | "never" | undefined;
     arrowParens?: "always" | "avoid" | undefined;
-    plugins?: (string | import("prettier").Plugin<any>)[] | undefined;
+    plugins?: (string | URL | import("prettier").Plugin<any>)[] | undefined;
     htmlWhitespaceSensitivity?: "strict" | "ignore" | "css" | undefined;
     endOfLine?: "auto" | "lf" | "crlf" | "cr" | undefined;
     quoteProps?: "preserve" | "as-needed" | "consistent" | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@p8ec/shared",
-	"version": "2.2.5",
+	"version": "2.4.1",
 	"description": "P(8) Global Shared Library for Javascript",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"build:assets": "cp -R src/assets dist",
 		"build:scripts": "cp -R ../scripts dist && chmod -R +x dist/scripts/*.sh",
 		"clean": "rm -rf dist docs coverage",
-		"cli": "NODE_ENV=development ts-node src/bin/p8-shared-cli.ts",
+		"cli:testrun": "NODE_ENV=development ts-node src/bin/p8-shared-cli.ts",
 		"test": "jest --no-cache --runInBand",
 		"test:cov": "jest --coverage --no-cache --runInBand",
 		"lint": "eslint --cache \"src/**/*.{js,jsx,ts,tsx}\"",
@@ -28,7 +28,6 @@
 		"docs:clean": "rimraf docs"
 	},
 	"bin": {
-		"p8-shared-cli": "dist/cjs/bin/p8-shared-cli.js",
 		"p8-cli": "dist/cjs/bin/p8-shared-cli.js"
 	},
 	"main": "dist/cjs/index.js",
@@ -36,13 +35,13 @@
 	"types": "dist/types/index.d.ts",
 	"license": "MIT",
 	"dependencies": {
-		"@eslint/js": "^9.28.0",
-		"eslint": "^9.28.0",
-		"eslint-config-prettier": "^10.1.5",
+		"@eslint/js": "^9.32.0",
+		"eslint": "^9.32.0",
+		"eslint-config-prettier": "^10.1.8",
 		"eslint-plugin-headers": "^1.3.3",
-		"eslint-plugin-prettier": "^5.4.1",
+		"eslint-plugin-prettier": "^5.5.3",
 		"ferramenta": "^1.3.2",
-		"prettier": "^3.5.3",
-		"typescript-eslint": "^8.33.1"
+		"prettier": "^3.6.2",
+		"typescript-eslint": "^8.38.0"
 	}
 }