Skip to content

Commit 019b1bb

Browse files
coliffcoliff
authored
Merge pull request #2 from htmlhint/dev/coliff/fixes
Normalize cspell config and update prettier script
2 parents b769d0b + 36ece32 commit 019b1bb

9 files changed

Lines changed: 125 additions & 64 deletions

File tree

‎.cspell.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"version": "0.2",
3+
"words": [
4+
"ZIZMOR"
5+
],
6+
"allowCompoundWords": true,
7+
"language": "en,en-US",
8+
"ignorePaths": [
9+
".cspell.json"
10+
],
11+
"useGitignore": true
12+
}

‎.editorconfig‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# EditorConfig helps developers define and maintain consistent
2+
# coding styles between different editors and IDEs
3+
# editorconfig.org
4+
5+
root = true
6+
7+
# Apply for all files
8+
[*]
9+
charset = utf-8
10+
indent_style = space
11+
indent_size = 2
12+
end_of_line = lf
13+
insert_final_newline = true
14+
trim_trailing_whitespace = true
15+
16+
# Apply for markdown files
17+
[*.md]
18+
19+
max_line_length = off
20+
trim_trailing_whitespace = false

‎.github/dependabot.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: "/"
5+
schedule:
6+
interval: monthly
7+
open-pull-requests-limit: 1
8+
cooldown:
9+
default-days: 7
10+
groups:
11+
github-actions:
12+
patterns:
13+
- "*"

‎.github/workflows/super-linter.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
name: Lint Code Base
3+
4+
on:
5+
push:
6+
branches-ignore:
7+
- "dependabot/**"
8+
pull_request:
9+
branches-ignore:
10+
- "dependabot/**"
11+
12+
permissions:
13+
contents: read
14+
15+
jobs:
16+
build:
17+
name: Lint Code Base
18+
runs-on: ubuntu-latest
19+
20+
permissions:
21+
contents: read
22+
packages: read
23+
statuses: write
24+
25+
steps:
26+
- name: Checkout Code
27+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
28+
with:
29+
fetch-depth: 0
30+
persist-credentials: false
31+
32+
- name: Super-linter
33+
uses: super-linter/super-linter/slim@12562e48d7059cf666c43a4ecb0d3b5a2b31bd9e # v8.4.0
34+
env:
35+
DEFAULT_BRANCH: main
36+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
37+
IGNORE_GITIGNORED_FILES: true
38+
LINTER_RULES_PATH: /
39+
LOG_LEVEL: NOTICE
40+
SUPPRESS_POSSUM: true
41+
VALIDATE_ALL_CODEBASE: false
42+
VALIDATE_BIOME_FORMAT: false
43+
VALIDATE_BIOME_LINT: false
44+
VALIDATE_GIT_COMMITLINT: false

‎.gitignore‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Files that might appear in the root of a volume
2+
.DocumentRevisions-V100
3+
.Spotlight-V100
4+
.TemporaryItems
5+
.Trashes
6+
7+
package-lock.json
8+
pnpm-lock.yaml
9+
yarn.lock
10+
bun.lockb
11+
bun.lock
12+
13+
.vscode
14+
.idea
15+
.DS_Store
16+
.env
17+
.env.local
18+
.env.development.local

‎.travis.yml‎

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,10 @@
44

55
First, thank you for considering contributing to the Awesome HTMLHint! It's people like you that make the open source community such a great community! 😊
66

7-
We welcome any type of contribution, not only code. You can help with
8-
- **QA**: file bug reports, the more details you can give the better (e.g. screenshots with the console open)
9-
- **Marketing**: writing blog posts, howto's, printing stickers, ...
10-
- **Community**: presenting the project at meetups, organizing a dedicated meetup for the local community, ...
11-
- **Code**: take a look at the [open issues](https://github.com/thedaviddias/awesome-htmlhint/issues). Even if you can't write code, commenting on them, showing that you care about a given issue matters. It helps us triage them.
12-
13-
## Your First Contribution
14-
15-
Working on your first Pull Request? You can learn how from this *free* series, [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github).
16-
177
## Submitting code
188

19-
Any code change should be submitted as a pull request. The description should explain what the code does and give steps to execute it. The pull request should also contain tests.
20-
21-
## Code review process
22-
23-
The bigger the pull request, the longer it will take to review and merge. Try to break down large pull requests in smaller chunks that are easier to review and merge.
24-
It is also always helpful to have some context for your pull request. What was the purpose? Why does it matter to you?
9+
Any change should be submitted as a pull request. The description should explain what the code does and give steps to execute it.
2510

2611
## Questions
2712

28-
If you have any questions, create an [issue](issue) (protip: do a quick search first to see if someone else didn't ask the same question before!).
29-
You can also reach us at thedaviddias@gmail.com.
30-
31-
<!-- This `CONTRIBUTING.md` is based on @nayafia's template https://github.com/nayafia/contributing-template -->
13+
If you have any questions, create an [issue](https://github.com/htmlhint/awesome-htmlhint/issues) (protip: do a quick search first to see if someone else didn't ask the same question before!).

‎README.md‎

Lines changed: 5 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,20 @@
44
55
## Contents
66

7-
- [Plugins](#plugins)
8-
- [Editors](#editors)
7+
- [Editor Plugins](#editor-plugins)
98
- [Tools](#tools)
10-
- [Build tools](#build-tools)
11-
- [Online tools](#online-tools)
12-
- [Tutorials](#tutorials)
139

14-
## Plugins
10+
### Editor Plugins
1511

16-
### Editors
17-
18-
- Visual Studio Code: [vscode-htmlhint](https://github.com/Microsoft/vscode-htmlhint)
19-
- Sublime Text 3: [SublimeLinter-contrib-htmlhint](https://github.com/HTMLHint/SublimeLinter-contrib-htmlhint)
20-
- Brackets: [brackets-htmlhint](https://github.com/HTMLHint/brackets-htmlhint)
21-
- Atom: [linter-htmlhint](https://github.com/AtomLinter/linter-htmlhint)
12+
- Visual Studio Code: [vscode-htmlhint](https://github.com/HTMLHint/vscode-htmlhint)
13+
- Sublime Text 3: [SublimeLinter-contrib-htmlhint](https://github.com/HTMLHint/SublimeLinter-contrib-htmlhint)
2214

2315
## Tools
2416

25-
## Build tools
26-
2717
- Grunt: [grunt-htmlhint](https://www.npmjs.com/package/grunt-htmlhint)
2818
- Gulp: [gulp-htmlhint](https://www.npmjs.com/package/gulp-htmlhint)
2919
- Webpack: [htmlhint-loader](https://www.npmjs.com/package/htmlhint-loader)
3020

31-
## Online tools
32-
33-
- Inspecode: [HTMLHint on Inspecode](https://inspecode.rocro.com/help/tools/htmlhint.html)
34-
35-
## Tutorials
36-
37-
- [HTMLHint Linter Codemirror Integration](https://www.youtube.com/watch?v=LjZI8bPSatY)
38-
3921
## Contribute
4022

4123
Contributions welcome! Read the [contribution guidelines](contributing.md) first.
@@ -44,6 +26,5 @@ Contributions welcome! Read the [contribution guidelines](contributing.md) first
4426

4527
[![CC0](http://mirrors.creativecommons.org/presskit/buttons/88x31/svg/cc-zero.svg)](http://creativecommons.org/publicdomain/zero/1.0)
4628

47-
To the extent possible under law, David Dias has waived all copyright and
29+
To the extent possible under law, HTMLHint has waived all copyright and
4830
related or neighboring rights to this work.
49-
`

‎package.json‎

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
11
{
22
"name": "awesome-htmlhint",
33
"version": "1.0.0",
4-
"description": "> This is an awesome list",
5-
"main": "index.js",
6-
"scripts": {
7-
4+
"description": "htmlhint list",
5+
"homepage": "https://github.com/htmlhint/awesome-htmlhint#readme",
6+
"bugs": {
7+
"url": "https://github.com/htmlhint/awesome-htmlhint/issues"
88
},
9-
"devDependencies": {
10-
"awesome-lint": "*"
11-
},
129
"repository": {
1310
"type": "git",
14-
"url": "git+https://thedaviddias@github.com/thedaviddias/awesome-htmlhint.git"
11+
"url": "git+https://github.com/htmlhint/awesome-htmlhint.git"
1512
},
16-
"keywords": [
17-
"awesome"
18-
],
19-
"author": "",
20-
"license": "ISC",
21-
"bugs": {
22-
"url": "https://github.com/thedaviddias/awesome-htmlhint/issues"
23-
},
24-
"homepage": "https://github.com/thedaviddias/awesome-htmlhint#readme"
13+
"license": "MIT",
14+
"author": "HTMLHint",
15+
"scripts": {
16+
"prettier": "npx prettier --write \"**/*.{md,yml}\"",
17+
"spellcheck": "npx cspell \"*.md\" --no-progress"
18+
}
2519
}

0 commit comments

Comments
 (0)