Restructure Codebase #215
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,202 @@ | ||
| { | ||
| "root": true, | ||
| "parserOptions": { | ||
| "ecmaVersion": 10, | ||
| "ecmaFeatures": { | ||
| "impliedStrict": true | ||
|
There was a problem hiding this comment. Some spaces in indentation in this file it looks like |
||
| }, | ||
| "sourceType": "module" | ||
| }, | ||
| "env": { | ||
| "browser": true, | ||
| "es6": true, | ||
| "node": true | ||
| }, | ||
| "extends": [ | ||
| "eslint:recommended" | ||
| ], | ||
| "ignorePatterns": ["dist", "types"], | ||
| "rules": { | ||
| "no-extra-boolean-cast": "error", | ||
| "array-bracket-spacing": [ | ||
| "error", | ||
|
There was a problem hiding this comment. For linting, I use |
||
| "always", | ||
| { | ||
| "objectsInArrays": false | ||
| } | ||
| ], | ||
| "block-spacing": ["error", "always"], | ||
| "brace-style": "error", | ||
| "comma-dangle": ["error", "always-multiline"], | ||
| "comma-spacing": [ | ||
| "error", | ||
| { | ||
| "before": false, | ||
| "after": true | ||
| } | ||
| ], | ||
| "comma-style": "error", | ||
| "curly": "error", | ||
| "computed-property-spacing": ["error", "never"], | ||
| "func-call-spacing": ["error", "never"], | ||
| "indent": ["error", "tab"], | ||
| "key-spacing": "error", | ||
| "keyword-spacing": "error", | ||
| "no-whitespace-before-property": "error", | ||
| "no-trailing-spaces": "error", | ||
| "object-curly-spacing": ["error", "always"], | ||
| "padded-blocks": ["error", "never"], | ||
| "semi": ["error", "never"], | ||
| "space-before-function-paren": ["error", "never"], | ||
| "space-in-parens": ["error", "never"], | ||
| "space-infix-ops": "error", | ||
| "space-unary-ops": [ | ||
| "error", | ||
| { | ||
| "words": true, | ||
| "nonwords": false | ||
| } | ||
| ], | ||
| "no-regex-spaces": "error", | ||
| "no-unsafe-negation": "error", | ||
| "dot-location": ["error", "property"], | ||
| "dot-notation": "error", | ||
| "no-extra-label": "error", | ||
| "no-multi-spaces": [ | ||
| "error", | ||
| { | ||
| "exceptions": { | ||
| "Property": false | ||
| } | ||
| } | ||
| ], | ||
| "no-useless-return": "error", | ||
| "eol-last": ["error", "always"], | ||
| "linebreak-style": "error", | ||
| "no-lonely-if": "error", | ||
| "no-unneeded-ternary": "error", | ||
| "object-curly-newline": [ | ||
| "error", | ||
| { | ||
| "consistent": true | ||
| } | ||
| ], | ||
| "operator-linebreak": ["error", "before"], | ||
| "quote-props": ["error", "as-needed"], | ||
| "quotes": ["error", "backtick"], | ||
| "space-before-blocks": ["error", "always"], | ||
| "spaced-comment": ["error", "always"], | ||
| "template-tag-spacing": "error", | ||
| "unicode-bom": "error", | ||
| "arrow-body-style": ["error", "as-needed"], | ||
| "arrow-parens": ["error", "always"], | ||
| "arrow-spacing": "error", | ||
| "generator-star-spacing": "error", | ||
| "no-useless-computed-key": "error", | ||
| "no-useless-rename": "error", | ||
| "no-var": "error", | ||
| "object-shorthand": "error", | ||
| "prefer-arrow-callback": [ | ||
| "error", | ||
| { | ||
| "allowNamedFunctions": true | ||
| } | ||
| ], | ||
| "prefer-const": "error", | ||
| "prefer-numeric-literals": "error", | ||
| "prefer-spread": "error", | ||
| "rest-spread-spacing": "error", | ||
| "template-curly-spacing": ["error", "always"], | ||
|
|
||
| "no-bitwise": "error", | ||
| "no-console": "off", | ||
| "no-debugger": "off", | ||
| "no-empty": "error", | ||
| "no-inner-declarations": "off", | ||
| "no-undef": "error", | ||
| "no-unused-vars": "warn" | ||
| }, | ||
| "overrides": [ | ||
| { | ||
| "files": [ | ||
| "**/*.ts" | ||
| ], | ||
| "parser": "@typescript-eslint/parser", | ||
| "parserOptions": { | ||
| "project": [ | ||
| "./tsconfig.json", | ||
| "./test/types/tsconfig.json" | ||
| ] | ||
| }, | ||
| "plugins": [ | ||
| "@typescript-eslint" | ||
| ], | ||
| "extends": [ | ||
| "plugin:@typescript-eslint/recommended", | ||
| "plugin:@typescript-eslint/recommended-requiring-type-checking" | ||
| ], | ||
| "rules": { | ||
| "@typescript-eslint/array-type": [ | ||
| "error", | ||
| { | ||
| "default": "generic" | ||
| } | ||
| ], | ||
| "@typescript-eslint/ban-types": [ | ||
| "error", | ||
| { | ||
| "types": { | ||
| "Object": { | ||
| "message": "Use object instead", | ||
| "fixWith": "object" | ||
| }, | ||
| "object": false | ||
| }, | ||
| "extendDefaults": true | ||
| } | ||
| ], | ||
| "@typescript-eslint/consistent-type-imports": "error", | ||
| "@typescript-eslint/prefer-interface": "off", | ||
| "@typescript-eslint/no-require-imports": "error", | ||
| "@typescript-eslint/no-unused-vars": "off", | ||
| "@typescript-eslint/no-unused-vars-experimental": [ | ||
| "warn", | ||
| { | ||
| "ignoredNamesRegex": "^_", | ||
| "ignoreArgsIfArgsAfterAreUsed": true | ||
| } | ||
| ], | ||
| "@typescript-eslint/no-use-before-define": [ | ||
| "error", | ||
| { | ||
| "functions": false, | ||
| "variables": true | ||
| } | ||
| ], | ||
|
|
||
| "@typescript-eslint/prefer-for-of": "warn", | ||
|
There was a problem hiding this comment. I detest for-of loop, personally. I don't want to get bogged down in a full audit of this eslintrc, maybe it could be pulled out to its own PR? |
||
| "@typescript-eslint/prefer-includes": "warn", | ||
| "@typescript-eslint/prefer-nullish-coalescing": "warn", | ||
| "@typescript-eslint/prefer-optional-chain": "warn", | ||
| "@typescript-eslint/prefer-string-starts-ends-with": "warn", | ||
| "@typescript-eslint/prefer-ts-expect-error": "warn", | ||
| "@typescript-eslint/switch-exhaustiveness-check": "warn", | ||
| "@typescript-eslint/unified-signatures": "warn", | ||
|
|
||
| "@typescript-eslint/no-explicit-any": "off", | ||
| "@typescript-eslint/no-unsafe-member-access": "off", | ||
| "@typescript-eslint/no-unsafe-assignment": "off", | ||
| "@typescript-eslint/no-unsafe-return": "off" | ||
| } | ||
| }, | ||
| { | ||
| "files": [ | ||
| "**/test/**/*", | ||
| "**/*test.ts" | ||
| ], | ||
| "rules": { | ||
| "no-unused-vars": "off" | ||
| } | ||
| } | ||
| ] | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| name: CI | ||
|
There was a problem hiding this comment. why move away from Travis in the same PR as all these other changes? |
||
|
|
||
| on: | ||
| - push | ||
| - pull_request | ||
|
|
||
| jobs: | ||
| lint: | ||
| name: Linting Checks | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Setup NodeJs | ||
| uses: actions/setup-node@v1 | ||
| with: | ||
| node-version: "14" | ||
|
|
||
| - name: Install Dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Run Linting Checks | ||
| run: npm run lint | ||
| test: | ||
| strategy: | ||
| fail-fast: true | ||
| matrix: | ||
| os: | ||
| - ubuntu-latest | ||
| node_version: | ||
| - "14" | ||
| - "12" | ||
| name: Test with Node ${{ matrix.node_version }} on ${{ matrix.os }} | ||
| runs-on: ${{ matrix.os }} | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v2 | ||
|
|
||
| - name: Setup NodeJs | ||
| uses: actions/setup-node@v1 | ||
| with: | ||
| node-version: ${{ matrix.node_version }} | ||
|
|
||
| - name: Install Dependencies | ||
| run: npm ci | ||
|
|
||
| - name: Run Tests | ||
| run: npm run test | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,4 @@ | ||
| node_modules | ||
| dist/* | ||
| types/* | ||
| !types/legacy* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I do tabs/trim-trailing-whitespace in Markdown too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My reason for switching to spaces in markdown files was just to ensure they render the same regardless of what render is being used - GitHub/npm/other.
But I don't have a strong opinion on this either way. I put this change its own commit so it can easily be dropped.
The reason for not trimming trailing whitespace at the end of markdown files is because two spaces at the end of a line is part of the markdown spec (meaning add a line break here). Official markdown doesn't treat a single line break any different to a single space when it comes to rendering. However, GitHub-flavored markdown, does treat single line break as an actual line break.
If you want to continue trimming trailing whitespace I'm ok with that but I'd recommend not doing so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Whitespace at the end of the line can be meaningful in Markdown, but I never use that line-break functionality in documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But the indent_style should definitely be tab 😅