Skip to content

Commit d18dac0

Browse files
dino-rodriguezdino-rodriguez
committed
skeleton and basic configuration
1 parent 9f44a33 commit d18dac0

18 files changed

+5457
-0
lines changed

‎.eslintignore

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Do not lint generated files.
2+
src/generated
3+
build
4+
dist
5+
6+
# Don't ever lint node_modules
7+
node_modules
8+
9+
# Do not lint configuration files
10+
.eslintrc.js
11+
nyc.config.js
12+
13+
# Do not lint js executable
14+
bin

‎.eslintrc.js

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
module.exports = {
2+
root: true,
3+
4+
parser: '@typescript-eslint/parser', // Make ESLint compatible with TypeScript
5+
parserOptions: {
6+
// Enable linting rules with type information from our tsconfig
7+
tsconfigRootDir: __dirname,
8+
project: ['./tsconfig.eslint.json'],
9+
10+
sourceType: 'module', // Allow the use of imports / ES modules
11+
12+
ecmaFeatures: {
13+
impliedStrict: true, // Enable global strict mode
14+
},
15+
},
16+
17+
// Specify global variables that are predefined
18+
env: {
19+
node: true, // Enable node global variables & Node.js scoping
20+
es2020: true, // Add all ECMAScript 2020 globals and automatically set the ecmaVersion parser option to ES2020
21+
},
22+
23+
plugins: [],
24+
extends: [
25+
'@xpring-eng/eslint-config-mocha',
26+
'@xpring-eng/eslint-config-base/loose',
27+
],
28+
29+
rules: {
30+
'import/no-unused-modules': 'off',
31+
'no-confusing-arrow': 0,
32+
},
33+
overrides: [],
34+
}

‎.github/ISSUE_TEMPLATE/bug-report.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Bug Report
3+
about: File a bug report to help us improve!
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
<!--- Provide a general summary of the issue in the Title above. -->
10+
11+
## Expected Behavior
12+
13+
<!--- A clear and concise description of what you expected to happen. -->
14+
15+
## Actual Behavior
16+
17+
<!--- A detailed description of what the bug is, and what the actual behavior is. -->
18+
19+
## Context
20+
21+
<!--- How has this issue affected you? What are you trying to accomplish? -->
22+
<!--- Providing context helps us come up with a solution that is most useful in the real world. -->
23+
24+
## Potential Solution
25+
26+
<!--- If you have a potential solution for how to address this, please suggest it. -->
27+
28+
## Steps to Reproduce
29+
30+
1. Step one
31+
2. Step two
32+
3. Step three
33+
34+
## Environment
35+
36+
- Node version:
37+
- NPM version:
38+
- Operating System and version:
39+
- App version:
40+
41+
### Screenshots
42+
43+
If applicable, add screenshots to help explain your problem.
44+
45+
## Bonus
46+
47+
**Are you willing to submit a pull request to fix this bug?**

‎.github/ISSUE_TEMPLATE/feature-request.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
<!--- Provide a general summary of the issue in the Title above. -->
10+
11+
## Detailed Description
12+
13+
<!--- Provide a detailed description of the change or addition you are proposing. -->
14+
15+
## Context
16+
17+
<!--- Why is this change important to you? How would you use it? -->
18+
<!--- How can it benefit other users? -->
19+
20+
## Possible Implementation
21+
22+
<!--- Not obligatory, but suggest an idea for implementing addition or change. -->
23+
24+
### Alternatives Considered
25+
26+
<!--- A clear and concise description of any alternative solutions or features you've considered. -->
27+
28+
## Additional Context
29+
30+
<!--- Add any other context or screenshots about the feature request here. -->
31+
32+
## Bonus
33+
34+
**Are you willing to submit a pull request to implement this change?**

‎.github/dependabot.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Dependabot configuration
2+
# https://help.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates
3+
version: 2
4+
updates:
5+
# GitHub Actions
6+
- package-ecosystem: 'github-actions'
7+
directory: '/'
8+
schedule:
9+
interval: 'weekly'
10+
11+
# NPM Dependencies
12+
- package-ecosystem: 'npm'
13+
directory: '/'
14+
schedule:
15+
interval: 'weekly'
16+
versioning-strategy: increase

‎.github/pull_request_template.md

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## High Level Overview of Change
2+
3+
<!--
4+
Please include a summary/list of the changes.
5+
If too broad, please consider splitting into multiple PRs.
6+
If a relevant Asana task, please link it here.
7+
-->
8+
9+
### Context of Change
10+
11+
<!--
12+
Please include the context of a change.
13+
If a bug fix, when was the bug introduced? What was the behavior?
14+
If a new feature, why was this architecture chosen? What were the alternatives?
15+
If a refactor, how is this better than the previous implementation?
16+
17+
If there is a design document for this feature, please link it here.
18+
-->
19+
20+
### Type of Change
21+
22+
<!--
23+
Please check relevant options, delete irrelevant ones.
24+
-->
25+
26+
- [ ] Bug fix (non-breaking change which fixes an issue)
27+
- [ ] New feature (non-breaking change which adds functionality)
28+
- [ ] Chore (project configuration, scripts, dotfiles, etc.)
29+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
30+
- [ ] Refactor (non-breaking change that only restructures code)
31+
- [ ] Tests (You added tests for code that already exists, or your new feature included in this PR)
32+
- [ ] Documentation Updates
33+
- [ ] Release
34+
35+
## Before / After
36+
37+
<!--
38+
If just refactoring / back-end changes, this can be just an in-English description of the change at a technical level.
39+
If a UI change, screenshots should be included.
40+
-->
41+
42+
## Test Plan
43+
44+
<!--
45+
Please describe the tests that you ran to verify your changes and provide instructions so that others can reproduce.
46+
-->
47+
48+
<!--
49+
## Future Tasks
50+
For future tasks related to PR.
51+
-->

‎.gitignore

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
build/
2+
node_modules/
3+
4+
*.code-workspace
5+
.nyc_output/

‎.mocharc.js

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
'use strict'
2+
3+
module.exports = {
4+
require: ['ts-node/register', 'source-map-support/register'],
5+
extension: ['ts'],
6+
7+
// Do not look for mocha opts file
8+
opts: false,
9+
10+
// Warn if test exceed 75ms duration
11+
slow: 75,
12+
13+
// Fail if tests exceed 10000ms
14+
timeout: 10000,
15+
16+
// Check for global variable leaks
17+
'check-leaks': true,
18+
}

‎.prettierignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Do not lint generated files.
2+
src/generated
3+
build
4+
dist
5+
.nyc_output
6+
7+
# Don't ever lint node_modules and NPM stuff
8+
.npm
9+
node_modules

‎.prettierrc.js

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
module.exports = {
2+
tabWidth: 2,
3+
printWidth: 80,
4+
singleQuote: true,
5+
semi: false,
6+
trailingComma: 'all',
7+
arrowParens: 'always',
8+
}

‎.vscode/settings.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"eslint.enable": true
3+
}

0 commit comments

Comments
 (0)