Skip to content

Commit 11695cb

Browse files
committed
feat: initial commit
0 parents  commit 11695cb

13 files changed

+6268
-0
lines changed

.editorconfig

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
end_of_line = lf
10+
max_line_length = null
11+
12+
[*.md]
13+
trim_trailing_whitespace = false
14+
15+
[*.rs]
16+
indent_size = 4
17+
18+
[Makefile]
19+
indent_style = tab
20+
trim_trailing_whitespace = false

.github/workflows/main.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: CI
2+
on: [push]
3+
4+
jobs:
5+
build:
6+
runs-on: ubuntu-latest
7+
8+
strategy:
9+
matrix:
10+
node-version: [8.x, 10.x, 12.x, 14.x]
11+
12+
steps:
13+
- uses: actions/checkout@v2
14+
- uses: actions/setup-node@v1
15+
with:
16+
node-version: ${{ matrix.node-version }}
17+
- run: yarn install
18+
- run: yarn build
19+
- run: yarn test
20+
env: { CI: 1 }

.gitignore

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
node_modules/
2+
3+
# config
4+
*.secrets.*
5+
6+
# common build sites
7+
dist/
8+
dist-types/
9+
10+
# build artifacts
11+
*.tsbuildinfo
12+
*.lcov
13+
coverage/
14+
.eslintcache
15+
16+
# logs and errors
17+
npm-debug.log*
18+
yarn-debug.log*
19+
yarn-error.log*
20+
lerna-debug.log*
21+
stats.json
22+
23+
# dev environments
24+
.vscode/*
25+
**/.DS_Store

.gitlab-ci.yml

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
include:
2+
- project: 'meat-n-potatoes/ci'
3+
file: 'all.yml'
4+
ref: v2
5+
6+
stages:
7+
- lint
8+
- build
9+
- test
10+
- publish
11+
12+
lint:
13+
extends: .node-lint
14+
stage: lint
15+
16+
build:
17+
extends: .node-build
18+
stage: build
19+
20+
test:
21+
extends: .node-test
22+
stage: test
23+
24+
publish:
25+
extends: .node-publish-tag
26+
stage: publish
27+
28+
publish-public:
29+
extends: .node-publish-tag-public
30+
stage: publish
31+
32+
sync-github-repo:
33+
extends: .sync-github-repo
34+
stage: publish
35+
only: [master]
36+
variables:
37+
GITHUB_SSH_URL: [email protected]:servall/api-fields.git

CONTRIBUTING.md

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Contributing to this package
2+
Thank you for your interest in contributing!
3+
4+
Below is a 'quick start' guide to developing. If there are details
5+
that we are missing here, feel free to file an issue or correct mistakes!
6+
7+
### Building
8+
We use `yarn`, and you should too if you plan to add or remove any npm packages.
9+
10+
```
11+
# installs 3rd party dependencies
12+
yarn install
13+
14+
# runs typescript and outputs in ./dist
15+
yarn build
16+
17+
# runs the unit tests
18+
yarn test
19+
20+
# runs our linter
21+
yarn lint
22+
```
23+
24+
The `build` and `test` command have a `--watch` option that will intelligently re-run when files change.
25+
26+
### Pull Request
27+
We will happily accept pull requests of any kind. Be sure that the tests
28+
pass and that the linter is happy before filling a PR, otherwise we'll
29+
need to tell you to fix those issues.
30+
31+
If you are adding anything new or changing behavior, please add applicable tests.

0 commit comments

Comments
 (0)