Skip to content

Commit

Permalink
chore: improve toolings for better DX (#126)
Browse files Browse the repository at this point in the history
* refactor: improve toolings
* chore: update GH templates
* build: update README, fix missing path in exports map

Signed-off-by: Rong Sen Ng (motss) <wes.ngrongsen@gmail.com>
  • Loading branch information
motss committed Oct 29, 2022
1 parent 71d5321 commit 5f96d66
Show file tree
Hide file tree
Showing 36 changed files with 4,866 additions and 1,606 deletions.
8 changes: 0 additions & 8 deletions .build.eslintrc.json

This file was deleted.

11 changes: 4 additions & 7 deletions .editorconfig
@@ -1,19 +1,16 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# http://editorconfig.org
# https://editorconfig.org

root = true

[*]
# Change these settings to your own preference
indent_style = space
indent_size = 2
indent_style = space

# We recommend you to keep these unchanged
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
end_of_line = lf
insert_final_newline = true

[*.md]
trim_trailing_whitespace = false
trim_trailing_whitespace = true
58 changes: 2 additions & 56 deletions .eslintrc.json
@@ -1,59 +1,5 @@
{
"env": {
"browser": true
},
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:promise/recommended",
"plugin:regexp/recommended"
],
"ignorePatterns": [
"**/*.mjs",
"vite.config.ts"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"project": "./tsconfig.json"
},
"plugins": [
"@typescript-eslint",
"simple-import-sort"
],
"rules": {
"no-async-promise-executor": "off",
"no-debugger": "off",
"no-unused-vars": "off",
"@typescript-eslint/no-unused-vars": [
"error", {
"argsIgnorePattern": "^_",
"varsIgnorePattern": "^_"
}
],
"comma-dangle": "off",
"@typescript-eslint/comma-dangle": [
"error", {
"arrays": "always-multiline",
"objects": "always-multiline",
"imports": "always-multiline",
"exports": "always-multiline",
"functions": "never"
}
],
"comma-spacing": "off",
"@typescript-eslint/comma-spacing": [
"error", {
"before": false,
"after": true
}
],
"@typescript-eslint/consistent-type-imports": [
"error", {
"prefer": "type-imports",
"disallowTypeAnnotations": false
}
],
"simple-import-sort/imports": "error",
"simple-import-sort/exports": "error"
}
"./node_modules/@reallyland/tools/.eslintrc.json"
]
}
5 changes: 4 additions & 1 deletion .gitattributes
@@ -1,5 +1,5 @@
# Automatically normalize line endings for all text-based files
# http://git-scm.com/docs/gitattributes#_end_of_line_conversion
# https://git-scm.com/docs/gitattributes#_end_of_line_conversion
* text=auto

# For the following file types, normalize line endings to LF on
Expand All @@ -8,10 +8,13 @@
# for example, after the build script is run)
.* text eol=lf
*.css text eol=lf
*.dart text eol=lf
*.html text eol=lf
*.js text eol=lf
*.json text eol=lf
*.jsx text eol=lf
*.md text eol=lf
*.rs text eol=lf
*.scss text eol=lf
*.sh text eol=lf
*.ts text eol=lf
Expand Down
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
@@ -0,0 +1 @@
* @motss
5 changes: 5 additions & 0 deletions .github/FUNDING.yml
@@ -0,0 +1,5 @@
# My Github Sponsors profile is live at 2022-04-03 14:33 SGT! 🚀 🎉
github: [motss]

# Buy me a matcha to support my passion!
custom: ['https://www.buymeacoffee.com/RLmMhgXFb']
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Expand Up @@ -26,6 +26,6 @@

### Versions of affected system

- **normalize-diacritics version**:
- **Node.js version**:
- **Package version**:
- **Platform details** _(e.g. macOS Sierra 10.12.4)_:
- **Other versions**:
38 changes: 20 additions & 18 deletions .github/PULL_REQUEST_TEMPLATE.md
@@ -1,28 +1,30 @@
### 💥 Breaking change
### Description

<!-- 1. Complete rewrite from ground up. -->
<!-- Tag the link to the issue ticket and write a summary of the problem and your solution(s), e.g.
Fix #1 by adding B and refactoring C.
-->

### 🐛 Fixes
### Changes

<!-- 1. Minor fix on issue. -->
<!-- Write a list of changes of your PR, e.g.
- Add A
- Update B
- Remove C
- Rename D
- Refactor E by doing E1
- Update tests after all the above changes
-->

### 🎨 Cleanup
### Testings

<!-- 1. Minor cleanup after rewrite. -->
<!-- Add screenshots or recordings of your new changes. -->

### Dependencies

### ✏️ Typo
<!-- List all dependencies, if any, e.g.
<!-- 1. Typo in documentation for codes. -->


### 📝 Documentation

<!-- 1. Updated README with breaking changes. -->


### :neckbeard: Reviewers

<!-- @master_bear PTAL and review the changes made. -->
1. [ ] #1
2. [ ] Currently blocked by #2
-->

0 comments on commit 5f96d66

Please sign in to comment.