Skip to content

Commit 6f2f7e4

Browse files
committed
first commit
0 parents  commit 6f2f7e4

28 files changed

+7150
-0
lines changed

.editorconfig

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_style = space
6+
indent_size = 2
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true

.eslintignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
./lib
2+
./jest.config.js
3+
./test/fixtures

.eslintrc.js

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
'use strict'
2+
3+
module.exports = {
4+
root: true,
5+
globals: {},
6+
env: {
7+
node: true,
8+
jest: true
9+
},
10+
extends: [
11+
'plugin:vue-libs/recommended',
12+
'plugin:@typescript-eslint/recommended',
13+
'plugin:@typescript-eslint/eslint-recommended',
14+
'prettier/@typescript-eslint',
15+
'plugin:prettier/recommended'
16+
],
17+
plugins: ['@typescript-eslint'],
18+
parser: 'vue-eslint-parser',
19+
parserOptions: {
20+
parser: '@typescript-eslint/parser',
21+
sourceType: 'module'
22+
},
23+
rules: {
24+
'object-curly-spacing': 'off',
25+
'@typescript-eslint/explicit-function-return-type': 'off',
26+
'@typescript-eslint/member-delimiter-style': 'off',
27+
'@typescript-eslint/no-use-before-define': 'off',
28+
'@typescript-eslint/explicit-module-boundary-types': 'off',
29+
'@typescript-eslint/ban-ts-comment': 'off',
30+
'@typescript-eslint/no-non-null-assertion': 'off'
31+
}
32+
}

.gitattributes

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.json linguist-language=JSON-with-Comments

.github/CONTRIBUTING.md

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# @intlify/cli Contributing Guide
2+
3+
- [Issue Reporting Guidelines](#issue-reporting-guidelines)
4+
- [Pull Request Guidelines](#pull-request-guidelines)
5+
- [Development Setup](#development-setup)
6+
7+
## Issue Reporting Guidelines
8+
9+
- The issue list of this repo is **exclusively** for bug reports and feature requests. Non-conforming issues will be closed immediately.
10+
11+
- Try to search for your issue, it may have already been answered or even fixed in the main branch.
12+
13+
- Check if the issue is reproducible with the latest stable version of @intlify/cli. If you are using a pre-release, please indicate the specific version you are using.
14+
15+
- It is **required** that you clearly describe the steps necessary to reproduce the issue you are running into. Issues with no clear repro steps will not be triaged. If an issue labeled `Status: Need More Info` receives no further input from the issue author for more than 5 days, it will be closed.
16+
17+
- For bugs that involves build setups, you can create a reproduction repository with steps in the README.
18+
19+
- If your issue is resolved but still open, don’t hesitate to close it. In case you found a solution by yourself, it could be helpful to explain how you fixed it.
20+
21+
## Pull Request Guidelines
22+
23+
- Checkout a topic branch from the `main` branch.
24+
25+
- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging.
26+
27+
- Make sure `npm test` passes. (see [development setup](#development-setup))
28+
29+
- If adding new feature:
30+
- Add accompanying test case.
31+
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it.
32+
33+
- If fixing a bug:
34+
- Provide detailed description of the bug in the PR.
35+
- Add appropriate test coverage if applicable.
36+
37+
### Work Step Example
38+
- Fork the repository from [@intlify/cli](https://github.com/intlify/cli) !
39+
- Create your topic branch from `main`: `git branch my-new-topic origin/main`
40+
- Add codes and pass tests !
41+
- Commit your changes: `git commit -am 'Add some topic'`
42+
- Push to the branch: `git push origin my-new-topic`
43+
- Submit a pull request to `main` branch of `intlify/api-docs-gen` repository !
44+
45+
## Development Setup
46+
47+
After cloning the repo, run:
48+
49+
$ npm install
50+
51+
### Commonly used NPM scripts
52+
53+
# lint source codes
54+
$ npm run lint
55+
56+
# run the full test suite, include linting
57+
$ npm test
58+
59+
There are some other scripts available in the `scripts` section of the `package.json` file.
60+
61+
The default test script will do the following: lint with ESLint -> unit tests with coverage. **Please make sure to have this pass successfully before submitting a PR.** Although the same tests will be run against your PR on the CI server, it is better to have it working locally beforehand.
62+

.github/FUNDING.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# These are supported funding model platforms
2+
3+
github: kazupon
4+
patreon: #
5+
open_collective: # Replace with a single Open Collective username
6+
ko_fi: # Replace with a single Ko-fi username
7+
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8+
issuehunt: #
9+
custom: # Replace with a single custom sponsorship URL

.github/ISSUE_TEMPLATE.md

Whitespace-only changes.

.github/PULL_REQUEST_TEMPLATE.md

Whitespace-only changes.

.github/workflows/test.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Test
2+
on:
3+
push:
4+
branches-ignore:
5+
- gh-pages
6+
pull_request:
7+
env:
8+
CI: true
9+
10+
jobs:
11+
test:
12+
name: "Test on Node.js ${{ matrix.node }} OS: ${{matrix.os}}"
13+
runs-on: ${{ matrix.os }}
14+
strategy:
15+
matrix:
16+
os: [ubuntu-latest]
17+
node: [10, 12, 14]
18+
steps:
19+
- name: Checkout
20+
uses: actions/checkout@v2
21+
- name: Setup Node.js ${{ matrix.node }}
22+
uses: actions/setup-node@v2
23+
with:
24+
node-version: ${{ matrix.node }}
25+
- name: Install
26+
run: yarn install
27+
- name: Test
28+
run: yarn test

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
coverage
2+
node_modules
3+
.DS_Store
4+
lib
5+
*.log
6+
*.swp
7+
*~
8+
temp

0 commit comments

Comments
 (0)