@plyaz/config 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +79 -0
- package/dist/index.cjs +10 -0
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +3 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +8 -0
- package/dist/index.js.map +1 -0
- package/package.json +122 -0
package/README.md
ADDED
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# @plyaz/config
|
|
2
|
+
|
|
3
|
+
Shared configuration constants and environment flags used throughout the Plyaz ecosystem. This package centralizes chain settings, feature toggles and other runtime values so that all apps share a single source of truth.
|
|
4
|
+
|
|
5
|
+
Install via pnpm:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
pnpm add @plyaz/config
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Development
|
|
12
|
+
|
|
13
|
+
### Setup
|
|
14
|
+
|
|
15
|
+
Install dependencies and run the basic checks:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm install
|
|
19
|
+
pnpm lint
|
|
20
|
+
pnpm test
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
### Build
|
|
24
|
+
|
|
25
|
+
Compile the library to the `dist` folder:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
pnpm build
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
For a watch mode during development:
|
|
32
|
+
|
|
33
|
+
```bash
|
|
34
|
+
pnpm dev
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Linting & Formatting
|
|
38
|
+
|
|
39
|
+
Run the ESLint rules and apply automatic fixes:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
pnpm lint
|
|
43
|
+
pnpm lint:fix
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Check or apply Prettier formatting:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pnpm format:check
|
|
50
|
+
pnpm format
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
### Tests
|
|
54
|
+
|
|
55
|
+
Execute the test suite once:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
pnpm test
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
Watch tests as you work:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
pnpm test:watch
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Generate coverage information:
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
pnpm test:coverage
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Relationship to Plyaz-Official/types
|
|
74
|
+
|
|
75
|
+
Type definitions for configuration values live in [Plyaz-Official/types](https://github.com/Plyaz-Official/types). Installing `@plyaz/types` alongside this package provides strongly typed access to each exported constant.
|
|
76
|
+
|
|
77
|
+
## About this repository
|
|
78
|
+
|
|
79
|
+
This package was scaffolded from the internal `package-template` and relies on [`@plyaz/devtools`](https://www.npmjs.com/package/@plyaz/devtools) for shared TypeScript, ESLint, Prettier and Vitest configuration.
|
package/dist/index.cjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;;;AAAO,IAAM,YAAA,GAAe","file":"index.cjs","sourcesContent":["export const PACKAGE_TEST = 1;\n"]}
|
package/dist/index.d.cts
ADDED
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare const PACKAGE_TEST = 1;
|
package/dist/index.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"names":[],"mappings":";;;AAAO,IAAM,YAAA,GAAe","file":"index.js","sourcesContent":["export const PACKAGE_TEST = 1;\n"]}
|
package/package.json
ADDED
|
@@ -0,0 +1,122 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@plyaz/config",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"author": "Redeemer Pace",
|
|
5
|
+
"license": "ISC",
|
|
6
|
+
"description": "Provides shared configs and constants for @playz ecosystem.",
|
|
7
|
+
"main": "./dist/index.js",
|
|
8
|
+
"module": "./dist/index.mjs",
|
|
9
|
+
"types": "./dist/index.d.ts",
|
|
10
|
+
"type": "module",
|
|
11
|
+
"exports": {
|
|
12
|
+
".": {
|
|
13
|
+
"types": "./dist/index.d.ts",
|
|
14
|
+
"import": "./dist/index.mjs",
|
|
15
|
+
"require": "./dist/index.js",
|
|
16
|
+
"default": "./dist/index.mjs"
|
|
17
|
+
},
|
|
18
|
+
"./translations": {
|
|
19
|
+
"types": "./dist/translations/index.d.ts"
|
|
20
|
+
},
|
|
21
|
+
"./package.json": "./package.json"
|
|
22
|
+
},
|
|
23
|
+
"files": [
|
|
24
|
+
"dist"
|
|
25
|
+
],
|
|
26
|
+
"engines": {
|
|
27
|
+
"node": ">=22.4.0",
|
|
28
|
+
"pnpm": ">=8.0.0"
|
|
29
|
+
},
|
|
30
|
+
"keywords": [],
|
|
31
|
+
"packageManager": "pnpm@10.11.0",
|
|
32
|
+
"devDependencies": {
|
|
33
|
+
"@changesets/cli": "^2.29.5",
|
|
34
|
+
"@darraghor/eslint-plugin-nestjs-typed": "^6.6.2",
|
|
35
|
+
"@eslint/eslintrc": "^3.2.0",
|
|
36
|
+
"@eslint/js": "^9.15.0",
|
|
37
|
+
"@eslint/markdown": "^6.5.0",
|
|
38
|
+
"@nestjs/common": "^11.1.3",
|
|
39
|
+
"@next/eslint-plugin-next": "^15.0.3",
|
|
40
|
+
"@plyaz/devtools": "^1.5.5",
|
|
41
|
+
"@types/node": "^20.0.0",
|
|
42
|
+
"@types/react": "^19.1.8",
|
|
43
|
+
"@typescript-eslint/eslint-plugin": "^8.15.0",
|
|
44
|
+
"@typescript-eslint/parser": "^8.15.0",
|
|
45
|
+
"@vitest/coverage-v8": "^3.1.3",
|
|
46
|
+
"eslint": "^9.29.0",
|
|
47
|
+
"eslint-config-next": "^15.3.3",
|
|
48
|
+
"eslint-config-prettier": "^9.1.0",
|
|
49
|
+
"eslint-import-resolver-typescript": "^3.10.1",
|
|
50
|
+
"eslint-mdx": "^3.5.0",
|
|
51
|
+
"eslint-plugin-better-tailwindcss": "3.2.1",
|
|
52
|
+
"eslint-plugin-functional": "^4.4.1",
|
|
53
|
+
"eslint-plugin-import": "^2.31.0",
|
|
54
|
+
"eslint-plugin-jest": "^28.13.5",
|
|
55
|
+
"eslint-plugin-jsdoc": "^50.8.0",
|
|
56
|
+
"eslint-plugin-jsonc": "^2.20.1",
|
|
57
|
+
"eslint-plugin-jsx-a11y": "^6.10.2",
|
|
58
|
+
"eslint-plugin-markdownlint": "^0.9.0",
|
|
59
|
+
"eslint-plugin-mdx": "^3.5.0",
|
|
60
|
+
"eslint-plugin-n": "^17.20.0",
|
|
61
|
+
"eslint-plugin-prettier": "^5.5.0",
|
|
62
|
+
"eslint-plugin-promise": "^7.2.1",
|
|
63
|
+
"eslint-plugin-react": "^7.37.2",
|
|
64
|
+
"eslint-plugin-react-hooks": "^5.0.0",
|
|
65
|
+
"eslint-plugin-react-refresh": "^0.4.19",
|
|
66
|
+
"eslint-plugin-regexp": "^2.9.0",
|
|
67
|
+
"eslint-plugin-security": "^3.0.1",
|
|
68
|
+
"eslint-plugin-simple-import-sort": "^12.1.1",
|
|
69
|
+
"eslint-plugin-sonarjs": "^0.23.0",
|
|
70
|
+
"eslint-plugin-storybook": "^0.12.0",
|
|
71
|
+
"eslint-plugin-testing-library": "^6.5.0",
|
|
72
|
+
"eslint-plugin-unicorn": "^56.0.1",
|
|
73
|
+
"eslint-plugin-unused-imports": "^4.1.4",
|
|
74
|
+
"jiti": "^2.4.2",
|
|
75
|
+
"jsdom": "^26.1.0",
|
|
76
|
+
"markdownlint": "^0.38.0",
|
|
77
|
+
"next": "15.3.3",
|
|
78
|
+
"prettier": "^3.5.3",
|
|
79
|
+
"standard-version": "^9.5.0",
|
|
80
|
+
"tailwindcss": "^4.1.8",
|
|
81
|
+
"tsup": "8.5.0",
|
|
82
|
+
"typescript": "^5",
|
|
83
|
+
"typescript-eslint": "^8.34.0",
|
|
84
|
+
"vitest": "3.2.4"
|
|
85
|
+
},
|
|
86
|
+
"peerDependenciesMeta": {
|
|
87
|
+
"react": {
|
|
88
|
+
"optional": true
|
|
89
|
+
},
|
|
90
|
+
"react-dom": {
|
|
91
|
+
"optional": true
|
|
92
|
+
},
|
|
93
|
+
"next": {
|
|
94
|
+
"optional": true
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"scripts": {
|
|
98
|
+
"build": "pnpm clean && pnpm build:js && pnpm build:types",
|
|
99
|
+
"build:js": "tsup",
|
|
100
|
+
"build:types": "tsc src/index.ts --emitDeclarationOnly --outDir dist --declaration",
|
|
101
|
+
"build:watch": "tsup --watch",
|
|
102
|
+
"dev": "tsup --watch",
|
|
103
|
+
"lint": "eslint ./src",
|
|
104
|
+
"lint:fix": "eslint ./src --fix",
|
|
105
|
+
"format": "prettier --write './**/*.{ts,tsx,js,jsx}'",
|
|
106
|
+
"format:check": "prettier --check './**/*.{ts,tsx,js,jsx}'",
|
|
107
|
+
"type:check": "tsc --noEmit",
|
|
108
|
+
"test": "vitest run --no-watch",
|
|
109
|
+
"test:ci": "vitest run --no-watch",
|
|
110
|
+
"test:watch": "vitest --watch",
|
|
111
|
+
"test:coverage": "vitest run --coverage",
|
|
112
|
+
"test:ui": "vitest --ui",
|
|
113
|
+
"clean": "rm -rf dist",
|
|
114
|
+
"audit": "pnpm audit",
|
|
115
|
+
"audit:moderate": "pnpm audit --audit-level moderate",
|
|
116
|
+
"audit:high": "pnpm audit --audit-level high",
|
|
117
|
+
"audit:critical": "pnpm audit --audit-level critical",
|
|
118
|
+
"audit:fix": "pnpm audit --fix",
|
|
119
|
+
"audit:enhanced": "npx audit-ci --moderate",
|
|
120
|
+
"security:check": "pnpm audit:moderate && npx audit-ci --moderate"
|
|
121
|
+
}
|
|
122
|
+
}
|