@p8ec/shared 1.0.0 → 1.1.1

package/README.md

@@ -1,4 +1,4 @@
-# P(8) Global Shared Library for Node.js and TypeScript/JavaScript.
+# P(8) Global Shared Library for Node.js and TypeScript/JavaScript
 
 This repository contains the shared library for all P(8) products.
 
@@ -8,16 +8,28 @@ This repository contains the shared configuration for all P(8) products.
 
 ### Usage
 
+#### Installation
+
+```shell
+npm i -D @p8ec/shared
+```
+
+#### Initialization
+
+```shell
+p8-shared-cli init
+```
+
+This command will create the following files in your project and remove corresponding configuration entries from `package.json`:
+
 #### **`.eslintrc.js`**
 
 ```javascript 
-// .eslintrc.js
 module.exports = require('@p8ec/shared').eslintConfigRecommended;
 ```
 
 #### **`.prettierrc.js`**
 
 ```javascript 
-// .prettierrc.js
 module.exports = require('@p8ec/shared').prettierConfigRecommended;
 ```

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

@@ -0,0 +1,88 @@
+#!/usr/bin/env node
+"use strict";
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * P8 Shared CLI tool.
+ *
+ * This tool is used to simplify the process of creating new P8 components.
+ *
+ * 	Usage:
+ * 		p8-shared [command] [options]
+ *
+ * 	Commands:
+ * 		init [--flavor=recommended]
+ * 			Initializes a new P8 component.
+ *				Options:
+ *					--flavor: The flavor of the component to create. Defaults to 'recommended'.
+ */
+const path = __importStar(require("path"));
+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;
+if (args.length === 0) {
+    // eslint-disable-next-line no-console
+    console.log(`
+Usage: ${self} [command] [options]
+
+Commands:
+	init [--flavor=recommended]
+		Initializes a new P8 component.
+			Options:
+				--flavor: The flavor of the component to create. Defaults to 'recommended'.
+`);
+    process.exit(1);
+}
+const init = () => {
+    // eslint-disable-next-line no-console
+    console.log('Creating .eslintrc.js...');
+    fs.writeFileSync(path.join(path.resolve(__dirname), '.eslintrc.js'), `module.exports = require('@p8ec/shared').eslintConfigRecommended;`);
+    // eslint-disable-next-line no-console
+    console.log('Creating .prettierrc.js...');
+    fs.writeFileSync(path.join(path.resolve(__dirname), '.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 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));
+};
+switch (args[0]) {
+    case 'init':
+        init();
+        break;
+    default:
+        // eslint-disable-next-line no-console
+        console.error(`Unknown command: ${args[0]}`);
+        process.exit(1);
+        break;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@p8ec/shared",
-	"version": "1.0.0",
+	"version": "1.1.1",
 	"description": "P(8) Global Shared Library",
 	"repository": {
 		"type": "git",
@@ -13,7 +13,7 @@
 	"scripts": {
 		"build": "npm run clean && npm run build:esm && npm run build:cjs && npm run build:types",
 		"build:esm": "tsc -p configs/tsconfig.esm.json",
-		"build:cjs": "tsc -p configs/tsconfig.cjs.json",
+		"build:cjs": "tsc -p configs/tsconfig.cjs.json && chmod -R +x dist/cjs/bin/*.js",
 		"build:types": "tsc -p configs/tsconfig.types.json",
 		"clean": "rimraf dist docs coverage",
 		"reset": "npm run clean && rimraf node_modules && npm install",
@@ -26,6 +26,9 @@
 		"docs:patch": "mv docs/functions docs/funcs && sed -i'.bak' 's/href=\\\"functions/href=\\\"funcs/g' docs/*.html",
 		"docs:clean": "rimraf docs"
 	},
+	"bin": {
+		"p8-shared-cli": "dist/cjs/bin/p8-shared-cli.js"
+	},
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
 	"types": "dist/types/index.d.ts",
@@ -116,5 +119,8 @@
 	"license": "MIT",
 	"lint-staged1": {
 		"*.{js,jsx,ts,tsx}": "npm run lint:fix"
+	},
+	"dependencies": {
+		"ferramenta": "^1.3.0"
 	}
 }