Skip to content

Commit 7d3dcb8

Browse files
travitravi
committed
chore: initial commit
closes #5, closes #4, closes #1
0 parents  commit 7d3dcb8

33 files changed

+24934
-0
lines changed

‎.babelrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"presets":["@form8ion"],"ignore":["./lib/"],"env":{"test":{"plugins":["istanbul"]}}}

‎.c8rc.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"reporter":["lcov","text-summary","html"],"exclude":["src/**/*-test.js","test/","thirdparty-wrappers/","vendor/"]}

‎.commitlintrc.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
module.exports = {extends: ['@form8ion']};

‎.czrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"path":"./node_modules/cz-conventional-changelog"}

‎.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# EditorConfig is awesome: http://EditorConfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
indent_style = space
10+
indent_size = 2
11+
end_of_line = lf
12+
insert_final_newline = true

‎.eslintignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
/coverage/
2+
/lib/

‎.eslintrc.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
root: true
2+
extends:
3+
- '@form8ion'
4+
- '@form8ion/cucumber'
5+
- '@form8ion/mocha'

‎.gherkin-lintrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"no-restricted-tags":["on",{"tags":["@focus"]}],"use-and":"on","no-multiple-empty-lines":"on","no-dupe-feature-names":"on"}

‎.gitattributes

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
* text=auto

‎.github/settings.yml

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
_extends: .github
2+
repository:
3+
name: commit-convention
4+
description: form8ion plugin for managing tools related to commit conventions
5+
homepage: https://npm.im/@form8ion/commit-convention
6+
private: false

‎.github/workflows/node-ci.yml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: Node.js CI
2+
'on':
3+
push:
4+
branches:
5+
- master
6+
- alpha
7+
- beta
8+
- renovate/**
9+
pull_request:
10+
types:
11+
- opened
12+
- synchronize
13+
env:
14+
FORCE_COLOR: 1
15+
NPM_CONFIG_COLOR: always
16+
jobs:
17+
verify:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v2
21+
- name: Read .nvmrc
22+
run: echo ::set-output name=NVMRC::$(cat .nvmrc)
23+
id: nvm
24+
- name: Setup node
25+
uses: actions/setup-node@v2
26+
with:
27+
node-version: ${{ steps.nvm.outputs.NVMRC }}
28+
- uses: bahmutov/npm-install@v1
29+
- run: npm test
30+
- name: Upload coverage data to Codecov
31+
run: npm run coverage:report
32+
release:
33+
needs: verify
34+
runs-on: ubuntu-latest
35+
steps:
36+
- uses: actions/checkout@v2
37+
- name: Setup node
38+
uses: actions/setup-node@v2
39+
with:
40+
node-version: lts/*
41+
- uses: bahmutov/npm-install@v1
42+
- name: semantic-release
43+
run: npx semantic-release
44+
env:
45+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
46+
NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
/node_modules/
2+
/lib/
3+
/coverage/
4+
5+
.eslintcache

‎.husky/commit-msg

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
npx --no-install commitlint --edit $1

‎.husky/pre-commit

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/bin/sh
2+
. "$(dirname "$0")/_/husky.sh"
3+
4+
npm test

‎.lockfile-lintrc.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"path":"package-lock.json","type":"npm","validate-https":true,"allowed-hosts":["npm"]}

‎.mocharc.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"ui":"tdd","require":["@babel/register","./test/mocha-setup.js"]}

‎.npmrc

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
update-notifier=false
2+
engine-strict=true

‎.nvmrc

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v16

‎.remarkrc.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"settings":{"listItemIndent":1,"emphasis":"_","strong":"_","bullet":"*","incrementListMarker":false},"plugins":["@form8ion/remark-lint-preset",["remark-toc",{"tight":true}],["remark-usage",{"heading":"example"}]]}

‎.renovaterc.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"$schema":"https://docs.renovatebot.com/renovate-schema.json","extends":["github>form8ion/renovate-config:js-package"]}

‎LICENSE

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
MIT License
2+
3+
Copyright (c) 2021 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.

‎README.md

+111
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
# commit-convention
2+
3+
form8ion plugin for managing tools related to commit conventions
4+
5+
<!--status-badges start -->
6+
7+
[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
8+
9+
<!--status-badges end -->
10+
11+
## Table of Contents
12+
13+
* [Usage](#usage)
14+
* [Installation](#installation)
15+
* [Example](#example)
16+
* [Contributing](#contributing)
17+
* [Dependencies](#dependencies)
18+
* [Verification](#verification)
19+
20+
## Usage
21+
22+
<!--consumer-badges start -->
23+
24+
[![MIT license][license-badge]][license-link]
25+
[![npm][npm-badge]][npm-link]
26+
[![Try @form8ion/commit-convention on RunKit][runkit-badge]][runkit-link]
27+
28+
<!--consumer-badges end -->
29+
30+
### Installation
31+
32+
```sh
33+
$ npm install @form8ion/commit-convention --save-prod
34+
```
35+
36+
### Example
37+
38+
#### Import
39+
40+
```javascript
41+
import {scaffold} from '@form8ion/commit-convention';
42+
```
43+
44+
#### Execute
45+
46+
```javascript
47+
(async () => {
48+
await scaffold({projectRoot: process.cwd()});
49+
})();
50+
```
51+
52+
## Contributing
53+
54+
<!--contribution-badges start -->
55+
56+
[![PRs Welcome][PRs-badge]][PRs-link]
57+
[![Commitizen friendly][commitizen-badge]][commitizen-link]
58+
[![Conventional Commits][commit-convention-badge]][commit-convention-link]
59+
[![semantic-release: angular][semantic-release-badge]][semantic-release-link]
60+
[![Renovate][renovate-badge]][renovate-link]
61+
62+
<!--contribution-badges end -->
63+
64+
### Dependencies
65+
66+
```sh
67+
$ nvm install
68+
$ npm install
69+
```
70+
71+
### Verification
72+
73+
```sh
74+
$ npm test
75+
```
76+
77+
[PRs-link]: http://makeapullrequest.com
78+
79+
[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
80+
81+
[commitizen-link]: http://commitizen.github.io/cz-cli/
82+
83+
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
84+
85+
[commit-convention-link]: https://conventionalcommits.org
86+
87+
[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
88+
89+
[semantic-release-link]: https://github.com/semantic-release/semantic-release
90+
91+
[semantic-release-badge]: https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release
92+
93+
[renovate-link]: https://renovatebot.com
94+
95+
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
96+
97+
[github-actions-ci-link]: https://github.com/form8ion/commit-convention/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
98+
99+
[github-actions-ci-badge]: https://github.com/form8ion/commit-convention/workflows/Node.js%20CI/badge.svg
100+
101+
[license-link]: LICENSE
102+
103+
[license-badge]: https://img.shields.io/github/license/form8ion/commit-convention.svg
104+
105+
[npm-link]: https://www.npmjs.com/package/@form8ion/commit-convention
106+
107+
[npm-badge]: https://img.shields.io/npm/v/@form8ion/commit-convention.svg
108+
109+
[runkit-link]: https://npm.runkit.com/@form8ion/commit-convention
110+
111+
[runkit-badge]: https://badge.runkitcdn.com/@form8ion/commit-convention.svg

‎cucumber.js

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
module.exports = {
2+
base: '--require-module @babel/register --format-options \'{"snippetInterface": "async-await"}\' --publish-quiet',
3+
wip: '--tags "@wip"',
4+
noWip: '--tags "not @wip"',
5+
focus: '--tags @focus'
6+
};

‎example.js

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// #### Import
2+
// remark-usage-ignore-next
3+
import stubbedFs from 'mock-fs';
4+
import {scaffold} from './lib/index.cjs';
5+
6+
// remark-usage-ignore-next
7+
stubbedFs();
8+
9+
// #### Execute
10+
11+
(async () => {
12+
await scaffold({projectRoot: process.cwd()});
13+
})();

0 commit comments

Comments
 (0)