@webpieces/rules 0.0.0-dev
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 +67 -0
- package/package.json +29 -0
- package/src/index.js +12 -0
- package/src/index.js.map +1 -0
package/README.md
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
# @webpieces/rules
|
|
2
|
+
|
|
3
|
+
Umbrella package for WebPieces development configuration and rules. This package installs all necessary development tooling.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install --save-dev @webpieces/rules
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## What's Included
|
|
12
|
+
|
|
13
|
+
This package installs:
|
|
14
|
+
|
|
15
|
+
- `@webpieces/dev-config` - ESLint rules, TypeScript config, Jest presets, and CLI scripts
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
Access configurations from dev-config:
|
|
20
|
+
|
|
21
|
+
```javascript
|
|
22
|
+
// eslint.config.js
|
|
23
|
+
import wpEslint from '@webpieces/dev-config/eslint';
|
|
24
|
+
export default wpEslint;
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
```json
|
|
28
|
+
// tsconfig.json
|
|
29
|
+
{
|
|
30
|
+
"extends": "@webpieces/dev-config/tsconfig"
|
|
31
|
+
}
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
```javascript
|
|
35
|
+
// jest.config.js
|
|
36
|
+
module.exports = {
|
|
37
|
+
preset: '@webpieces/dev-config/jest'
|
|
38
|
+
};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## CLI Scripts
|
|
42
|
+
|
|
43
|
+
After installation, you'll have access to WebPieces CLI commands:
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
wp-start # Start the development server
|
|
47
|
+
wp-stop # Stop the development server
|
|
48
|
+
wp-set-version # Set version for all packages
|
|
49
|
+
wp-use-local # Switch to local WebPieces packages
|
|
50
|
+
wp-use-published # Switch to published WebPieces packages
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Version Compatibility
|
|
54
|
+
|
|
55
|
+
All @webpieces packages use lock-step versioning. Always use matching versions:
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"devDependencies": {
|
|
60
|
+
"@webpieces/rules": "0.2.10"
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## License
|
|
66
|
+
|
|
67
|
+
Apache-2.0
|
package/package.json
ADDED
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@webpieces/rules",
|
|
3
|
+
"version": "0.0.0-dev",
|
|
4
|
+
"description": "Umbrella package for WebPieces development tooling and configurations",
|
|
5
|
+
"type": "commonjs",
|
|
6
|
+
"author": "Dean Hiller",
|
|
7
|
+
"license": "Apache-2.0",
|
|
8
|
+
"repository": {
|
|
9
|
+
"type": "git",
|
|
10
|
+
"url": "https://github.com/deanhiller/webpieces-ts.git",
|
|
11
|
+
"directory": "packages/rules"
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"webpieces",
|
|
15
|
+
"eslint",
|
|
16
|
+
"typescript",
|
|
17
|
+
"jest",
|
|
18
|
+
"dev-config",
|
|
19
|
+
"umbrella"
|
|
20
|
+
],
|
|
21
|
+
"publishConfig": {
|
|
22
|
+
"access": "public"
|
|
23
|
+
},
|
|
24
|
+
"dependencies": {
|
|
25
|
+
"@webpieces/dev-config": "0.0.0-dev"
|
|
26
|
+
},
|
|
27
|
+
"types": "./src/index.d.ts",
|
|
28
|
+
"main": "./src/index.js"
|
|
29
|
+
}
|
package/src/index.js
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/**
|
|
3
|
+
* @webpieces/rules - Umbrella package for development tooling
|
|
4
|
+
*
|
|
5
|
+
* This is a Maven-style umbrella package that installs development tooling.
|
|
6
|
+
* Access configurations from dev-config:
|
|
7
|
+
*
|
|
8
|
+
* @example
|
|
9
|
+
* import wpEslint from '@webpieces/dev-config/eslint';
|
|
10
|
+
*/
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
//# sourceMappingURL=index.js.map
|
package/src/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/rules/src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * @webpieces/rules - Umbrella package for development tooling\n *\n * This is a Maven-style umbrella package that installs development tooling.\n * Access configurations from dev-config:\n *\n * @example\n * import wpEslint from '@webpieces/dev-config/eslint';\n */\n\n// This file exists only to satisfy build requirements.\n// Users should import from constituent packages, not from this umbrella package.\nexport {};\n"]}
|