@p8ec/shared 1.1.7 → 1.2.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.
+- `dirn` - Get the directory name. Options: `0` - current directory (default), `1` - parent directory, `2` - 2 levels up
+  directory, etc.
+

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

@@ -47,9 +47,10 @@ 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);
 if (args.length === 0) {
-    // eslint-disable-next-line no-console
-    console.log(`
+    writeLn(`
 Usage: ${self} [command] [options]
 
 Commands:
@@ -60,25 +61,51 @@ Commands:
 `);
     process.exit(1);
 }
+/**
+ * Initializes a TypeScript project with P8 shared configurations.
+ */
 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...');
+    writeLn('Creating .eslintrc.js...');
+    writeFile('.eslintrc.js', `module.exports = require('@p8ec/shared').eslintConfigRecommended;`);
+    writeLn('Creating .prettierrc.js...');
+    writeFile('.prettierrc.js', `module.exports = require('@p8ec/shared').prettierConfigRecommended;`);
+    // Cleanup package.json
+    writeLn('Removing eslintConfig and prettier from package.json...');
     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));
+    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));
+};
+/**
+ * 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];
+};
+/**
+ * Returns the caller PID
+ */
+const pid = () => {
+    return process.pid;
 };
 switch (args[0]) {
     case 'init':
         init();
         break;
+    case 'dirn':
+        writeLn(dirn(args[1]));
+        break;
     default:
         // eslint-disable-next-line no-console
         console.error(`Unknown command: ${args[0]}`);

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@p8ec/shared",
-	"version": "1.1.7",
+	"version": "1.2.0",
 	"description": "P(8) Global Shared Library",
 	"repository": {
 		"type": "git",
@@ -16,6 +16,7 @@
 		"build:cjs": "tsc -p configs/tsconfig.cjs.json && chmod -R +x dist/cjs/bin/*.js",
 		"build:types": "tsc -p configs/tsconfig.types.json",
 		"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",
 		"test": "jest --no-cache --runInBand",
@@ -27,7 +28,8 @@
 		"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",
@@ -117,13 +119,13 @@
 		"*.{js,jsx,ts,tsx}": "npm run lint:fix"
 	},
 	"peerDependencies": {
-		"ferramenta": "^1.3.0",
-		"@typescript-eslint/eslint-plugin": "^7.7.0",
+		"@typescript-eslint/eslint-plugin": "^7",
 		"@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"
+		"eslint-config-prettier": "^9",
+		"eslint-plugin-header": "^3",
+		"eslint-plugin-prettier": "^5",
+		"ferramenta": "^1.3.0",
+		"prettier": "^3.3.3"
 	}
 }