@form8ion/github-workflows-core 1.0.0-alpha.1
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/LICENSE +20 -0
- package/README.md +116 -0
- package/example.js +13 -0
- package/lib/index.js +10 -0
- package/lib/index.js.map +1 -0
- package/lib/index.mjs +6 -0
- package/lib/index.mjs.map +1 -0
- package/package.json +86 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2022 Matt Travi
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
6
|
+
this software and associated documentation files (the "Software"), to deal in
|
|
7
|
+
the Software without restriction, including without limitation the rights to
|
|
8
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
9
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
10
|
+
subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
17
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
18
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
19
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
20
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# github-workflows-core
|
|
2
|
+
|
|
3
|
+
core functionality for form8ion plugins that manage github workflows
|
|
4
|
+
|
|
5
|
+
<!--status-badges start -->
|
|
6
|
+
|
|
7
|
+
[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
|
|
8
|
+
[![Codecov][coverage-badge]][coverage-link]
|
|
9
|
+
|
|
10
|
+
<!--status-badges end -->
|
|
11
|
+
|
|
12
|
+
## Table of Contents
|
|
13
|
+
|
|
14
|
+
* [Usage](#usage)
|
|
15
|
+
* [Installation](#installation)
|
|
16
|
+
* [Example](#example)
|
|
17
|
+
* [Contributing](#contributing)
|
|
18
|
+
* [Dependencies](#dependencies)
|
|
19
|
+
* [Verification](#verification)
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
<!--consumer-badges start -->
|
|
24
|
+
|
|
25
|
+
[![MIT license][license-badge]][license-link]
|
|
26
|
+
[![npm][npm-badge]][npm-link]
|
|
27
|
+
[![Try @form8ion/github-workflows-core on RunKit][runkit-badge]][runkit-link]
|
|
28
|
+
|
|
29
|
+
<!--consumer-badges end -->
|
|
30
|
+
|
|
31
|
+
### Installation
|
|
32
|
+
|
|
33
|
+
```sh
|
|
34
|
+
$ npm install @form8ion/github-workflows-core --save-prod
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Example
|
|
38
|
+
|
|
39
|
+
#### Import
|
|
40
|
+
|
|
41
|
+
```javascript
|
|
42
|
+
import {scaffold} from './lib/index.cjs';
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
#### Execute
|
|
46
|
+
|
|
47
|
+
```javascript
|
|
48
|
+
(async () => {
|
|
49
|
+
await scaffold({projectRoot: process.cwd()});
|
|
50
|
+
})();
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Contributing
|
|
54
|
+
|
|
55
|
+
<!--contribution-badges start -->
|
|
56
|
+
|
|
57
|
+
[![PRs Welcome][PRs-badge]][PRs-link]
|
|
58
|
+
[![Commitizen friendly][commitizen-badge]][commitizen-link]
|
|
59
|
+
[![Conventional Commits][commit-convention-badge]][commit-convention-link]
|
|
60
|
+
[![semantic-release: angular][semantic-release-badge]][semantic-release-link]
|
|
61
|
+
[![Renovate][renovate-badge]][renovate-link]
|
|
62
|
+
|
|
63
|
+
<!--contribution-badges end -->
|
|
64
|
+
|
|
65
|
+
### Dependencies
|
|
66
|
+
|
|
67
|
+
```sh
|
|
68
|
+
$ nvm install
|
|
69
|
+
$ npm install
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
### Verification
|
|
73
|
+
|
|
74
|
+
```sh
|
|
75
|
+
$ npm test
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
[PRs-link]: http://makeapullrequest.com
|
|
79
|
+
|
|
80
|
+
[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
|
|
81
|
+
|
|
82
|
+
[commitizen-link]: http://commitizen.github.io/cz-cli/
|
|
83
|
+
|
|
84
|
+
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
|
|
85
|
+
|
|
86
|
+
[commit-convention-link]: https://conventionalcommits.org
|
|
87
|
+
|
|
88
|
+
[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
|
|
89
|
+
|
|
90
|
+
[semantic-release-link]: https://github.com/semantic-release/semantic-release
|
|
91
|
+
|
|
92
|
+
[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release
|
|
93
|
+
|
|
94
|
+
[renovate-link]: https://renovatebot.com
|
|
95
|
+
|
|
96
|
+
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
|
|
97
|
+
|
|
98
|
+
[github-actions-ci-link]: https://github.com/form8ion/github-workflows-core/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
|
|
99
|
+
|
|
100
|
+
[github-actions-ci-badge]: https://github.com/form8ion/github-workflows-core/workflows/Node.js%20CI/badge.svg
|
|
101
|
+
|
|
102
|
+
[coverage-link]: https://codecov.io/github/form8ion/github-workflows-core
|
|
103
|
+
|
|
104
|
+
[coverage-badge]: https://img.shields.io/codecov/c/github/form8ion/github-workflows-core?logo=codecov
|
|
105
|
+
|
|
106
|
+
[license-link]: LICENSE
|
|
107
|
+
|
|
108
|
+
[license-badge]: https://img.shields.io/github/license/form8ion/github-workflows-core.svg
|
|
109
|
+
|
|
110
|
+
[npm-link]: https://www.npmjs.com/package/@form8ion/github-workflows-core
|
|
111
|
+
|
|
112
|
+
[npm-badge]: https://img.shields.io/npm/v/@form8ion/github-workflows-core?logo=npm
|
|
113
|
+
|
|
114
|
+
[runkit-link]: https://npm.runkit.com/@form8ion/github-workflows-core
|
|
115
|
+
|
|
116
|
+
[runkit-badge]: https://badge.runkitcdn.com/@form8ion/github-workflows-core.svg
|
package/example.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
// #### Import
|
|
2
|
+
// remark-usage-ignore-next
|
|
3
|
+
import stubbedFs from 'mock-fs';
|
|
4
|
+
import {scaffold} from './lib/index.js';
|
|
5
|
+
|
|
6
|
+
// remark-usage-ignore-next
|
|
7
|
+
stubbedFs();
|
|
8
|
+
|
|
9
|
+
// #### Execute
|
|
10
|
+
|
|
11
|
+
(async () => {
|
|
12
|
+
await scaffold({projectRoot: process.cwd()});
|
|
13
|
+
})();
|
package/lib/index.js
ADDED
package/lib/index.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../src/scaffolder.js"],"sourcesContent":["export default function () {\n return undefined;\n}\n"],"names":[],"mappings":";;;;AAAe,mBAAQ,IAAI;AAC3B,EAAE,OAAO,SAAS,CAAC;AACnB;;;;"}
|
package/lib/index.mjs
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.mjs","sources":["../src/scaffolder.js"],"sourcesContent":["export default function () {\n return undefined;\n}\n"],"names":[],"mappings":"AAAe,mBAAQ,IAAI;AAC3B,EAAE,OAAO,SAAS,CAAC;AACnB;;;;"}
|
package/package.json
ADDED
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@form8ion/github-workflows-core",
|
|
3
|
+
"description": "core functionality for form8ion plugins that manage github workflows",
|
|
4
|
+
"license": "MIT",
|
|
5
|
+
"type": "commonjs",
|
|
6
|
+
"version": "1.0.0-alpha.1",
|
|
7
|
+
"files": [
|
|
8
|
+
"example.js",
|
|
9
|
+
"lib/"
|
|
10
|
+
],
|
|
11
|
+
"publishConfig": {
|
|
12
|
+
"access": "public"
|
|
13
|
+
},
|
|
14
|
+
"runkitExampleFilename": "./example.js",
|
|
15
|
+
"main": "lib/index.js",
|
|
16
|
+
"module": "lib/index.mjs",
|
|
17
|
+
"exports": {
|
|
18
|
+
"require": "./lib/index.js",
|
|
19
|
+
"import": "./lib/index.mjs"
|
|
20
|
+
},
|
|
21
|
+
"sideEffects": false,
|
|
22
|
+
"repository": "form8ion/github-workflows-core",
|
|
23
|
+
"bugs": "https://github.com/form8ion/github-workflows-core/issues",
|
|
24
|
+
"homepage": "https://npm.im/@form8ion/github-workflows-core",
|
|
25
|
+
"author": "Matt Travi <npm@travi.org> (https://matt.travi.org)",
|
|
26
|
+
"scripts": {
|
|
27
|
+
"test": "npm-run-all --print-label build --parallel lint:* --parallel test:*",
|
|
28
|
+
"pretest:integration:base": "preview",
|
|
29
|
+
"lint:gherkin": "gherkin-lint",
|
|
30
|
+
"test:integration": "run-s 'test:integration:base -- --profile noWip'",
|
|
31
|
+
"test:integration:base": "NODE_OPTIONS=--enable-source-maps DEBUG=any cucumber-js test/integration --profile base",
|
|
32
|
+
"test:integration:debug": "DEBUG=test run-s test:integration",
|
|
33
|
+
"test:integration:wip": "run-s 'test:integration:base -- --profile wip'",
|
|
34
|
+
"test:integration:wip:debug": "DEBUG=test run-s 'test:integration:wip'",
|
|
35
|
+
"test:integration:focus": "run-s 'test:integration:base -- --profile focus'",
|
|
36
|
+
"build:js": "rollup --config",
|
|
37
|
+
"watch": "run-s 'build:js -- --watch'",
|
|
38
|
+
"clean": "rimraf ./lib",
|
|
39
|
+
"prebuild": "run-s clean",
|
|
40
|
+
"build": "npm-run-all --print-label --parallel build:*",
|
|
41
|
+
"prepack": "run-s build",
|
|
42
|
+
"test:unit": "cross-env NODE_ENV=test c8 run-s test:unit:base",
|
|
43
|
+
"test:unit:base": "DEBUG=any mocha 'src/**/*-test.js'",
|
|
44
|
+
"lint:lockfile": "lockfile-lint",
|
|
45
|
+
"lint:js": "eslint . --cache",
|
|
46
|
+
"lint:js:fix": "run-s lint:js -- --fix",
|
|
47
|
+
"lint:md": "remark . --frail",
|
|
48
|
+
"generate:md": "remark . --output",
|
|
49
|
+
"pregenerate:md": "run-s build",
|
|
50
|
+
"lint:sensitive": "ban",
|
|
51
|
+
"prepare": "husky install",
|
|
52
|
+
"lint:peer": "npm ls >/dev/null"
|
|
53
|
+
},
|
|
54
|
+
"devDependencies": {
|
|
55
|
+
"@babel/register": "7.17.7",
|
|
56
|
+
"@cucumber/cucumber": "8.2.0",
|
|
57
|
+
"@form8ion/babel-preset": "1.6.87",
|
|
58
|
+
"@form8ion/commitlint-config": "1.0.31",
|
|
59
|
+
"@form8ion/eslint-config": "5.0.2",
|
|
60
|
+
"@form8ion/eslint-config-cucumber": "1.4.1",
|
|
61
|
+
"@form8ion/eslint-config-mocha": "2.0.1",
|
|
62
|
+
"@form8ion/remark-lint-preset": "4.0.0",
|
|
63
|
+
"@rollup/plugin-babel": "5.3.1",
|
|
64
|
+
"@travi/any": "2.0.20",
|
|
65
|
+
"babel-plugin-istanbul": "6.1.1",
|
|
66
|
+
"ban-sensitive-files": "1.9.18",
|
|
67
|
+
"c8": "7.11.2",
|
|
68
|
+
"chai": "4.3.6",
|
|
69
|
+
"cross-env": "7.0.3",
|
|
70
|
+
"cz-conventional-changelog": "3.3.0",
|
|
71
|
+
"gherkin-lint": "4.2.2",
|
|
72
|
+
"husky": "8.0.1",
|
|
73
|
+
"lockfile-lint": "4.7.4",
|
|
74
|
+
"mocha": "10.0.0",
|
|
75
|
+
"mock-fs": "5.1.2",
|
|
76
|
+
"npm-run-all": "4.1.5",
|
|
77
|
+
"package-preview": "4.0.0",
|
|
78
|
+
"remark-cli": "10.0.1",
|
|
79
|
+
"remark-toc": "8.0.1",
|
|
80
|
+
"remark-usage": "10.0.1",
|
|
81
|
+
"rimraf": "3.0.2",
|
|
82
|
+
"rollup": "2.72.1",
|
|
83
|
+
"rollup-plugin-auto-external": "2.0.0",
|
|
84
|
+
"sinon": "14.0.0"
|
|
85
|
+
}
|
|
86
|
+
}
|