Skip to content

Commit 49f444f

Browse files
travitravi
committed
chore: initial commit
closes #2, closes #3, closes #4
0 parents  commit 49f444f

20 files changed

+6080
-0
lines changed

‎.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

‎.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: eslint-config-typescript
4+
description: shareable ESLint config for TypeScript projects
5+
homepage: https://npm.im/@form8ion/eslint-config-typescript
6+
private: false

‎.github/workflows/node-ci.yml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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+
release:
31+
needs: verify
32+
runs-on: ubuntu-latest
33+
steps:
34+
- uses: actions/checkout@v2
35+
- name: Read .nvmrc
36+
run: echo ::set-output name=NVMRC::$(cat .nvmrc)
37+
id: nvm
38+
- name: Setup node
39+
uses: actions/setup-node@v2
40+
with:
41+
node-version: ${{ steps.nvm.outputs.NVMRC }}
42+
- uses: bahmutov/npm-install@v1
43+
- name: semantic-release
44+
run: npx semantic-release
45+
env:
46+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47+
NPM_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN }}

‎.gitignore

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

‎.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"]}

‎.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+
v14

‎.remarkrc.js

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// https://github.com/remarkjs/remark/tree/master/packages/remark-stringify#options
2+
exports.settings = {
3+
listItemIndent: 1,
4+
emphasis: '_',
5+
strong: '_',
6+
bullet: '*',
7+
incrementListMarker: false
8+
};
9+
10+
exports.plugins = [
11+
'@form8ion/remark-lint-preset',
12+
['remark-toc', {tight: true}],
13+
['remark-usage', {heading: 'example'}]
14+
];

‎.renovaterc.json

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"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

+98
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,98 @@
1+
# eslint-config-typescript
2+
3+
[shareable](https://eslint.org/docs/developer-guide/shareable-configs#shareable-configs)
4+
[ESLint](https://eslint.org) config for
5+
[TypeScript](https://www.typescriptlang.org/) projects
6+
7+
<!--status-badges start -->
8+
9+
[![Node CI Workflow Status][github-actions-ci-badge]][github-actions-ci-link]
10+
11+
<!--status-badges end -->
12+
13+
## Table of Contents
14+
15+
* [Usage](#usage)
16+
* [Installation](#installation)
17+
* [Example](#example)
18+
* [Contributing](#contributing)
19+
* [Dependencies](#dependencies)
20+
* [Verification](#verification)
21+
22+
## Usage
23+
24+
<!--consumer-badges start -->
25+
26+
[![MIT license][license-badge]][license-link]
27+
[![npm][npm-badge]][npm-link]
28+
29+
<!--consumer-badges end -->
30+
31+
### Installation
32+
33+
```sh
34+
$ npm install @form8ion/eslint-config-typescript --save-dev
35+
```
36+
37+
### Example
38+
39+
```javascript
40+
const eslintConfigTypescript = require('.');
41+
```
42+
43+
## Contributing
44+
45+
<!--contribution-badges start -->
46+
47+
[![PRs Welcome][PRs-badge]][PRs-link]
48+
[![Commitizen friendly][commitizen-badge]][commitizen-link]
49+
[![Conventional Commits][commit-convention-badge]][commit-convention-link]
50+
[![semantic-release][semantic-release-badge]][semantic-release-link]
51+
[![Renovate][renovate-badge]][renovate-link]
52+
53+
<!--contribution-badges end -->
54+
55+
### Dependencies
56+
57+
```sh
58+
$ nvm install
59+
$ npm install
60+
```
61+
62+
### Verification
63+
64+
```sh
65+
$ npm test
66+
```
67+
68+
[PRs-link]: http://makeapullrequest.com
69+
70+
[PRs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
71+
72+
[commitizen-link]: http://commitizen.github.io/cz-cli/
73+
74+
[commitizen-badge]: https://img.shields.io/badge/commitizen-friendly-brightgreen.svg
75+
76+
[commit-convention-link]: https://conventionalcommits.org
77+
78+
[commit-convention-badge]: https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg
79+
80+
[semantic-release-link]: https://github.com/semantic-release/semantic-release
81+
82+
[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
83+
84+
[renovate-link]: https://renovatebot.com
85+
86+
[renovate-badge]: https://img.shields.io/badge/renovate-enabled-brightgreen.svg?logo=renovatebot
87+
88+
[github-actions-ci-link]: https://github.com/form8ion/eslint-config-typescript/actions?query=workflow%3A%22Node.js+CI%22+branch%3Amaster
89+
90+
[github-actions-ci-badge]: https://github.com/form8ion/eslint-config-typescript/workflows/Node.js%20CI/badge.svg
91+
92+
[license-link]: LICENSE
93+
94+
[license-badge]: https://img.shields.io/github/license/form8ion/eslint-config-typescript.svg
95+
96+
[npm-link]: https://www.npmjs.com/package/@form8ion/eslint-config-typescript
97+
98+
[npm-badge]: https://img.shields.io/npm/v/@form8ion/eslint-config-typescript.svg

‎example.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
const eslintConfigTypescript = require('.');

‎index.js

Whitespace-only changes.

0 commit comments

Comments
 (0)