@p8ec/shared 1.1.7 → 1.3.0

package/README.md

@@ -1,10 +1,10 @@
-# P(8) Global Shared Library for Node.js and TypeScript/JavaScript
+# P(8) Shared Libraries for Node.js
 
-This repository contains the shared library for all P(8) products.
+Shared TypeScript/JavaScript libraries for P(8) products.
 
-## Javascript Shared Configuration
+## Shared Configuration
 
-This repository contains the shared configuration for all P(8) products.
+Shared configuration for P(8) projects.
 
 ### Usage
 
@@ -17,10 +17,11 @@ npm i -D @p8ec/shared
 #### Initialization
 
 ```shell
-p8-shared-cli init
+p8-cli init
 ```
 
-This command will create the following files in your project and remove corresponding configuration entries from `package.json`:
+This command will create the following files in your project and remove corresponding configuration entries
+from `package.json`:
 
 #### **`.eslintrc.js`**
 
@@ -33,3 +34,18 @@ module.exports = require('@p8ec/shared').eslintConfigRecommended;
 ```javascript 
 module.exports = require('@p8ec/shared').prettierConfigRecommended;
 ```
+
+## P(8) CLI Tool
+
+### Syntax
+
+```shell
+p8-cli [command] [options]
+```
+
+### Commands
+
+- `init` - Initialize P(8) shared configuration in your project. Options: `cleanup` - remove configuration entries from `package.json`
+- `dirn` - Get the directory name. Options: `0` - current directory (default), `1` - parent directory, `2` - 2 levels up
+  directory, etc.
+

package/dist/assets/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require('@p8ec/shared').eslintConfigRecommended;

package/dist/assets/.eslintrc.mjs

@@ -0,0 +1,3 @@
+import { eslintConfigRecommended } from '@p8ec/shared';
+
+export default eslintConfigRecommended;

package/dist/assets/.prettierrc.cjs

@@ -0,0 +1 @@
+module.exports = require('@p8ec/shared').prettierConfigRecommended;

package/dist/assets/.prettierrc.mjs

@@ -0,0 +1,3 @@
+import { prettierConfigRecommended } from '@p8ec/shared';
+
+export default prettierConfigRecommended;

package/dist/assets/lefthook.yml

@@ -0,0 +1,7 @@
+#   Refer for explanation to following link:
+#   https://github.com/evilmartians/lefthook/blob/master/docs/configuration.md
+
+commit-msg:
+  commands:
+    commitlint:
+      run: npx --no -- commitlint --edit {1}

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

@@ -47,9 +47,11 @@ const fs = __importStar(require("fs"));
 const ferramenta_1 = require("ferramenta");
 const args = ferramenta_1.processArgs.args;
 const self = path.parse(ferramenta_1.processArgs.name).name;
+const writeLn = console.log;
+const writeFile = (name, data) => fs.writeFileSync(path.join(process.cwd(), name), data);
+const copyAsset = (name) => fs.copyFileSync(path.join(__dirname, '..', 'assets', name), path.join(process.cwd(), name));
 if (args.length === 0) {
-    // eslint-disable-next-line no-console
-    console.log(`
+    writeLn(`
 Usage: ${self} [command] [options]
 
 Commands:
@@ -60,24 +62,51 @@ Commands:
 `);
     process.exit(1);
 }
-const init = () => {
-    // eslint-disable-next-line no-console
-    console.log('Creating .eslintrc.js...');
-    fs.writeFileSync(path.join(process.cwd(), '.eslintrc.js'), `module.exports = require('@p8ec/shared').eslintConfigRecommended;`);
-    // eslint-disable-next-line no-console
-    console.log('Creating .prettierrc.js...');
-    fs.writeFileSync(path.join(process.cwd(), '.prettierrc.js'), `module.exports = require('@p8ec/shared').prettierConfigRecommended;`);
-    // Remove eslintConfig and prettier from package.json
-    // eslint-disable-next-line no-console
-    console.log('Removing eslintConfig and prettier from package.json...');
+const initCleanup = (packageJson) => {
+    writeLn('Removing eslintConfig and prettier from package.json...');
+    if (packageJson['eslintConfig']) {
+        writeLn('Backing up eslintConfig to eslint.package.json.bak...');
+        writeFile('eslint.package.json.bak', packageJson['eslintConfig']);
+        delete packageJson['eslintConfig'];
+    }
+    if (packageJson['prettier']) {
+        writeLn('Backing up prettier to prettier.package.json.bak...');
+        writeFile('prettier.package.json.bak', packageJson['prettier']);
+        delete packageJson['prettier'];
+    }
+    writeFile('package.json', JSON.stringify(packageJson, null, 2));
+};
+/**
+ * Initializes a TypeScript project with P8 shared configurations.
+ */
+const init = (option) => {
     const packageJson = JSON.parse(String(fs.readFileSync(path.join(process.cwd(), 'package.json'))));
-    delete packageJson['eslintConfig'];
-    delete packageJson['prettier'];
-    fs.writeFileSync(path.join(process.cwd(), 'package.json'), JSON.stringify(packageJson, null, 2));
+    const moduleType = packageJson['type'] === 'module' ? 'mjs' : 'cjs';
+    writeLn(`Creating .eslintrc.${moduleType}...`);
+    copyAsset(`.eslintrc.${moduleType}`);
+    writeLn(`Creating .prettierrc.${moduleType}...`);
+    copyAsset(`.prettierrc.${moduleType}`);
+    writeLn('Creating lefthook.yml...');
+    copyAsset('lefthook.yml');
+    if (option.split(',').includes('cleanup')) {
+        initCleanup(packageJson);
+    }
+};
+/**
+ * Returns the directory name of the caller, optionally returns a directory name specified levels up.
+ */
+const dirn = (levelsUp) => {
+    const DEFAULT_LEVELS_UP = 0;
+    levelsUp !== null && levelsUp !== void 0 ? levelsUp : (levelsUp = `${DEFAULT_LEVELS_UP}`);
+    const levels = parseInt(levelsUp) || DEFAULT_LEVELS_UP;
+    return process.cwd().split(path.sep).reverse()[levels];
 };
 switch (args[0]) {
     case 'init':
-        init();
+        init(args[1]);
+        break;
+    case 'dirn':
+        writeLn(dirn(args[1]));
         break;
     default:
         // eslint-disable-next-line no-console

package/package.json

@@ -1,7 +1,8 @@
 {
 	"name": "@p8ec/shared",
-	"version": "1.1.7",
+	"version": "1.3.0",
 	"description": "P(8) Global Shared Library",
+	"license": "MIT",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/p8ec/p8-shared.git"
@@ -11,13 +12,15 @@
 	},
 	"homepage": "https://github.com/p8ec/p8-shared",
 	"scripts": {
-		"build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:types",
+		"build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:types && npm run build:assets",
 		"build:esm": "tsc -p configs/tsconfig.esm.json",
 		"build:cjs": "tsc -p configs/tsconfig.cjs.json && chmod -R +x dist/cjs/bin/*.js",
 		"build:types": "tsc -p configs/tsconfig.types.json",
+		"build:assets": "cp -R src/assets dist",
 		"clean": "rm -rf dist docs coverage",
+		"cli": "ts-node src/bin/p8-shared-cli.ts",
 		"reset": "npm run clean && rm -rf node_modules && npm install",
-		"prepare": "husky install",
+		"postinstall": "lefthook install",
 		"test": "jest --no-cache --runInBand",
 		"test:cov": "jest --coverage --no-cache --runInBand",
 		"lint": "eslint --cache \"src/**/*.{js,jsx,ts,tsx}\"",
@@ -27,26 +30,35 @@
 		"docs:clean": "rimraf docs"
 	},
 	"bin": {
-		"p8-shared-cli": "dist/cjs/bin/p8-shared-cli.js"
+		"p8-shared-cli": "dist/cjs/bin/p8-shared-cli.js",
+		"p8-cli": "dist/cjs/bin/p8-shared-cli.js"
 	},
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
 	"types": "dist/types/index.d.ts",
-	"devDependencies": {
+	"dependencies": {
 		"@commitlint/cli": "^19.3.0",
 		"@commitlint/config-conventional": "^19.2.2",
-		"@swc/cli": "^0.3.12",
-		"@swc/core": "^1.5.27",
-		"@swc/jest": "^0.2.36",
+		"lefthook": "^1.7.6",
+		"@typescript-eslint/eslint-plugin": "^7",
+		"@typescript-eslint/parser": "^7.7.0",
+		"eslint": "^8 || ^9",
+		"eslint-config-prettier": "^9",
+		"eslint-plugin-header": "^3",
+		"eslint-plugin-prettier": "^5",
+		"prettier": "^3.3.3"
+	},
+	"devDependencies": {
 		"@types/jest": "^29.5.12",
-		"husky": "^9.0.11",
 		"jest": "^29.7.0",
 		"lint-staged": "^15.2.5",
 		"rimraf": "^5.0.7",
 		"ts-node": "^10.9.2",
-		"typedoc": "^0.25.13",
 		"typescript": "^5.4.5"
 	},
+	"peerDependencies": {
+		"ferramenta": "^1.3.0"
+	},
 	"eslintConfig": {
 		"env": {
 			"node": true,
@@ -70,7 +82,8 @@
 			"*.config.ts",
 			"*.config.js",
 			"*rc.ts",
-			"*rc.js"
+			"*rc.js",
+			"src/assets"
 		],
 		"rules": {
 			"@typescript-eslint/interface-name-prefix": "off",
@@ -111,19 +124,5 @@
 		"extends": [
 			"@commitlint/config-conventional"
 		]
-	},
-	"license": "MIT",
-	"lint-staged1": {
-		"*.{js,jsx,ts,tsx}": "npm run lint:fix"
-	},
-	"peerDependencies": {
-		"ferramenta": "^1.3.0",
-		"@typescript-eslint/eslint-plugin": "^7.7.0",
-		"@typescript-eslint/parser": "^7.7.0",
-		"eslint": "^8 || ^9",
-		"eslint-config-prettier": "^9.1.0",
-		"eslint-plugin-header": "^3.1.1",
-		"eslint-plugin-prettier": "^5.1.0",
-		"prettier": "3.2.5"
 	}
 }