@p8ec/shared 1.0.0

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2022 Xorde Labs
+Copyright (c) 2022 Xander Tovski
+Copyright (c) 2023 Alexander Mochkin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+# P(8) Global Shared Library for Node.js and TypeScript/JavaScript.
+
+This repository contains the shared library for all P(8) products.
+
+## Javascript Shared Configuration
+
+This repository contains the shared configuration for all P(8) products.
+
+### Usage
+
+#### **`.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/eslintConfigRecommended.js

@@ -0,0 +1,50 @@
+"use strict";
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * Recommended ESLint configuration for TypeScript projects.
+ */
+const eslintConfigRecommended = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        project: 'tsconfig.json',
+        sourceType: 'module',
+    },
+    ignorePatterns: ['.eslintrc.js', '.prettierrc.js', 'dist/', 'node_modules/'],
+    plugins: ['@typescript-eslint/eslint-plugin', 'header'],
+    extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+    root: true,
+    env: {
+        node: true,
+        jest: true,
+    },
+    rules: {
+        '@typescript-eslint/interface-name-prefix': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                varsIgnorePattern: '^_',
+            },
+        ],
+        'header/header': [
+            2,
+            'block',
+            [
+                '*',
+                ' * 2023 Copyright P8 Enterprise Components, Inc.',
+                ' * All Rights Reserved.',
+                ' * Private and Confidential.',
+                ' ',
+            ],
+            2,
+        ],
+    },
+};
+exports.default = eslintConfigRecommended;

package/dist/cjs/index.js

@@ -0,0 +1,15 @@
+"use strict";
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettierConfigRecommended = exports.eslintConfigRecommended = void 0;
+const eslintConfigRecommended_1 = __importDefault(require("./eslintConfigRecommended"));
+exports.eslintConfigRecommended = eslintConfigRecommended_1.default;
+const prettierConfigRecommended_1 = __importDefault(require("./prettierConfigRecommended"));
+exports.prettierConfigRecommended = prettierConfigRecommended_1.default;

package/dist/cjs/prettierConfigRecommended.js

@@ -0,0 +1,20 @@
+"use strict";
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettierConfigRecommended = void 0;
+/**
+ * Recommended Prettier configuration.
+ */
+exports.prettierConfigRecommended = {
+    singleQuote: true,
+    trailingComma: 'all',
+    tabWidth: 2,
+    useTabs: true,
+    printWidth: 120,
+    bracketSpacing: true,
+};
+exports.default = exports.prettierConfigRecommended;

package/dist/esm/eslintConfigRecommended.js

@@ -0,0 +1,48 @@
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+/**
+ * Recommended ESLint configuration for TypeScript projects.
+ */
+const eslintConfigRecommended = {
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        project: 'tsconfig.json',
+        sourceType: 'module',
+    },
+    ignorePatterns: ['.eslintrc.js', '.prettierrc.js', 'dist/', 'node_modules/'],
+    plugins: ['@typescript-eslint/eslint-plugin', 'header'],
+    extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+    root: true,
+    env: {
+        node: true,
+        jest: true,
+    },
+    rules: {
+        '@typescript-eslint/interface-name-prefix': 'off',
+        '@typescript-eslint/explicit-function-return-type': 'off',
+        '@typescript-eslint/explicit-module-boundary-types': 'off',
+        '@typescript-eslint/no-explicit-any': 'off',
+        '@typescript-eslint/no-unused-vars': [
+            'error',
+            {
+                varsIgnorePattern: '^_',
+            },
+        ],
+        'header/header': [
+            2,
+            'block',
+            [
+                '*',
+                ' * 2023 Copyright P8 Enterprise Components, Inc.',
+                ' * All Rights Reserved.',
+                ' * Private and Confidential.',
+                ' ',
+            ],
+            2,
+        ],
+    },
+};
+export default eslintConfigRecommended;

package/dist/esm/index.js

@@ -0,0 +1,8 @@
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+import eslintConfigRecommended from './eslintConfigRecommended';
+import prettierConfigRecommended from './prettierConfigRecommended';
+export { eslintConfigRecommended, prettierConfigRecommended };

package/dist/esm/prettierConfigRecommended.js

@@ -0,0 +1,17 @@
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+/**
+ * Recommended Prettier configuration.
+ */
+export const prettierConfigRecommended = {
+    singleQuote: true,
+    trailingComma: 'all',
+    tabWidth: 2,
+    useTabs: true,
+    printWidth: 120,
+    bracketSpacing: true,
+};
+export default prettierConfigRecommended;

package/dist/types/eslintConfigRecommended.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+import { ClassicConfig } from '@typescript-eslint/utils/ts-eslint';
+/**
+ * Recommended ESLint configuration for TypeScript projects.
+ */
+declare const eslintConfigRecommended: ClassicConfig.Config;
+export default eslintConfigRecommended;

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+import eslintConfigRecommended from './eslintConfigRecommended';
+import prettierConfigRecommended from './prettierConfigRecommended';
+export { eslintConfigRecommended, prettierConfigRecommended };

package/dist/types/prettierConfigRecommended.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 2023 Copyright P8 Enterprise Components, Inc.
+ * All Rights Reserved.
+ * Private and Confidential.
+ */
+import { Options } from 'prettier';
+/**
+ * Recommended Prettier configuration.
+ */
+export declare const prettierConfigRecommended: Options;
+export default prettierConfigRecommended;

package/package.json

@@ -0,0 +1,120 @@
+{
+	"name": "@p8ec/shared",
+	"version": "1.0.0",
+	"description": "P(8) Global Shared Library",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/p8ec/p8-shared.git"
+	},
+	"bugs": {
+		"url": "https://github.com/p8ec/p8-shared/issues"
+	},
+	"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:esm": "tsc -p configs/tsconfig.esm.json",
+		"build:cjs": "tsc -p configs/tsconfig.cjs.json",
+		"build:types": "tsc -p configs/tsconfig.types.json",
+		"clean": "rimraf dist docs coverage",
+		"reset": "npm run clean && rimraf node_modules && npm install",
+		"prepare": "husky install",
+		"test": "jest --no-cache --runInBand",
+		"test:cov": "jest --coverage --no-cache --runInBand",
+		"lint": "eslint --cache \"src/**/*.{js,jsx,ts,tsx}\"",
+		"lint:fix": "eslint --cache --fix \"src/**/*.{js,jsx,ts,tsx}\"",
+		"docs:build": "typedoc --name 'P(8) Global Shared Library' --includeVersion --readme README_GENERATED.md --out docs src",
+		"docs:patch": "mv docs/functions docs/funcs && sed -i'.bak' 's/href=\\\"functions/href=\\\"funcs/g' docs/*.html",
+		"docs:clean": "rimraf docs"
+	},
+	"main": "dist/cjs/index.js",
+	"module": "dist/esm/index.js",
+	"types": "dist/types/index.d.ts",
+	"devDependencies": {
+		"@commitlint/cli": "^19.2.1",
+		"@commitlint/config-conventional": "^19.1.0",
+		"@swc/cli": "^0.3.12",
+		"@swc/core": "^1.4.11",
+		"@swc/jest": "^0.2.36",
+		"@types/jest": "^29.5.11",
+		"@typescript-eslint/eslint-plugin": "^7.5.0",
+		"@typescript-eslint/parser": "^7.5.0",
+		"eslint": "^8.56.0",
+		"eslint-config-prettier": "^9.1.0",
+		"eslint-plugin-header": "^3.1.1",
+		"eslint-plugin-prettier": "^5.1.0",
+		"husky": "^9.0.11",
+		"jest": "^29.7.0",
+		"lint-staged": "^15.2.0",
+		"prettier": "3.2.5",
+		"rimraf": "^5.0.5",
+		"ts-node": "^10.9.2",
+		"typedoc": "^0.25.4",
+		"typescript": "^5.3.3"
+	},
+	"eslintConfig": {
+		"env": {
+			"node": true,
+			"jest": true
+		},
+		"parser": "@typescript-eslint/parser",
+		"plugins": [
+			"@typescript-eslint",
+			"header"
+		],
+		"extends": [
+			"eslint:recommended",
+			"plugin:@typescript-eslint/recommended",
+			"plugin:prettier/recommended"
+		],
+		"ignorePatterns": [
+			"node_modules",
+			"build",
+			"dist",
+			"docs"
+		],
+		"rules": {
+			"@typescript-eslint/interface-name-prefix": "off",
+			"@typescript-eslint/explicit-function-return-type": "off",
+			"@typescript-eslint/explicit-module-boundary-types": "off",
+			"@typescript-eslint/no-explicit-any": "off",
+			"@typescript-eslint/no-unused-vars": [
+				"error",
+				{
+					"varsIgnorePattern": "^_"
+				}
+			],
+			"header/header": [
+				2,
+				"block",
+				[
+					"*",
+					" * 2023 Copyright P8 Enterprise Components, Inc.",
+					" * All Rights Reserved.",
+					" * Private and Confidential.",
+					" "
+				],
+				2
+			]
+		}
+	},
+	"lint-staged": {
+		"*.{js,jsx,ts,tsx}": "npm run lint:fix"
+	},
+	"prettier": {
+		"singleQuote": true,
+		"trailingComma": "all",
+		"tabWidth": 2,
+		"useTabs": true,
+		"printWidth": 120,
+		"bracketSpacing": true
+	},
+	"commitlint": {
+		"extends": [
+			"@commitlint/config-conventional"
+		]
+	},
+	"license": "MIT",
+	"lint-staged1": {
+		"*.{js,jsx,ts,tsx}": "npm run lint:fix"
+	}
+}