Skip to content

Commit 23df7d1

Browse files
danielroedanielroe
committed
chore: initial commit
0 parents  commit 23df7d1

35 files changed

+13817
-0
lines changed

‎.editorconfig

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_size = 2
6+
indent_style = space
7+
end_of_line = lf
8+
charset = utf-8
9+
trim_trailing_whitespace = true
10+
insert_final_newline = true
11+
12+
[*.md]
13+
trim_trailing_whitespace = false

‎.eslintignore

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
node_modules
2+
dist
3+
.nuxt
4+
coverage
5+
*.log*
6+
.DS_Store
7+
.code
8+
*.iml
9+
package-lock.json
10+
templates/*

‎.eslintrc.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
extends: ['@nuxtjs/eslint-config-typescript']
3+
}

‎.github/ISSUE_TEMPLATE/bug_report.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
---
2+
name: Bug report
3+
about: Report a bug report to help us improve the module.
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
### Version
11+
module: <!-- ex: 5.9.0 -->
12+
nuxt: <!-- ex: 2.0.0 -->
13+
14+
### Nuxt configuration
15+
#### [mode](https://nuxtjs.org/api/configuration-mode): <!--universal is the default -->
16+
- [ ] universal
17+
- [ ] spa
18+
19+
### Nuxt configuration
20+
<!--
21+
If relevant, please include the configuration you are using for this module.
22+
For example:
23+
```
24+
```
25+
-->
26+
27+
## Reproduction
28+
> :warning: without a minimal reproduction we wont be able to look into your issue
29+
30+
**Link:**
31+
[ ] https:///codesandbox.io/
32+
[ ] GitHub repository
33+
34+
#### What is expected?
35+
#### What is actually happening?
36+
#### Steps to reproduce
37+
## Additional information
38+
## Checklist
39+
* [ ] I have tested with the latest Nuxt version and the issue still occurs
40+
* [ ] I have tested with the latest module version and the issue still occurs
41+
* [ ] I have searched the issue tracker and this issue hasn't been reported yet
42+
43+
### Steps to reproduce
44+
45+
46+
### What is expected?
47+
48+
49+
### What is actually happening?
50+
<!-- Add any other context or screenshots about the feature request here. -->
51+
52+
### Performance analysis?
53+
<!-- Add any performance metrics or regressions here -->

‎.github/ISSUE_TEMPLATE/config.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Nuxt Community Discord
4+
url: https://discord.nuxtjs.org/
5+
about: Consider asking questions about the module here.
6+
# - name: Documentation
7+
# url: /README.md
8+
# about: Check our documentation before reporting issues or questions.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea or enhancement for this project.
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
### Is your feature request related to a problem? Please describe.
11+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
12+
13+
### Describe the solution you'd like to see
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
### Describe alternatives you've considered
17+
<!-- A clear and concise description of any alternative solutions or features you've considered. -->
18+
19+
### Additional context
20+
<!-- Add any other context or screenshots about the feature request here. -->

‎.github/ISSUE_TEMPLATE/question.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Question
3+
about: Ask a question about the module.
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
12+
**IMPORTANT!**
13+
Please make sure to look for an answer to your question in our documentation before asking a question here.
14+
15+
If you have a general question regarding {{ name }} use Discord `modules` channel. Thanks!
16+
17+
Documentation: {{ docs }}
18+
Nuxt Discord: https://discord.nuxtjs.org/
19+
20+
-->

‎.github/workflows/ci.yml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
name: ci
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
pull_request:
8+
branches:
9+
- master
10+
11+
jobs:
12+
ci:
13+
runs-on: ${{ matrix.os }}
14+
15+
strategy:
16+
matrix:
17+
os: [ubuntu-latest, macos-latest, windows-latest]
18+
node: [10, 12]
19+
20+
steps:
21+
- uses: actions/setup-node@v1
22+
with:
23+
node-version: ${{ matrix.node }}
24+
25+
- name: checkout
26+
uses: actions/checkout@v2
27+
28+
- name: cache node_modules
29+
uses: actions/cache@v2
30+
with:
31+
path: node_modules
32+
key: ${{ matrix.os }}-node-v${{ matrix.node }}-deps-${{ hashFiles(format('{0}{1}', github.workspace, '/yarn.lock')) }}
33+
34+
- name: Install dependencies
35+
if: steps.cache.outputs.cache-hit != 'true'
36+
run: yarn
37+
38+
- name: Lint
39+
run: yarn lint
40+
41+
- name: Test
42+
run: yarn test
43+
44+
- name: Coverage
45+
uses: codecov/codecov-action@v1

‎.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
node_modules
2+
*.iml
3+
.idea
4+
*.log*
5+
.nuxt
6+
.vscode
7+
.DS_Store
8+
coverage
9+
dist

‎.release-it.json

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"git": {
3+
"commitMessage": "chore: release v${version}"
4+
},
5+
"github": {
6+
"release": true,
7+
"releaseName": "v${version}",
8+
"releaseNotes": "echo \"${changelog}\" | sed 1,2d"
9+
},
10+
"plugins": {
11+
"@release-it/conventional-changelog": {
12+
"preset": "conventionalcommits",
13+
"infile": "CHANGELOG.md"
14+
}
15+
}
16+
}

‎LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c)
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# @nuxtjs/html-validator
2+
3+
[![npm version][npm-version-src]][npm-version-href]
4+
[![npm downloads][npm-downloads-src]][npm-downloads-href]
5+
[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]
6+
[![Codecov][codecov-src]][codecov-href]
7+
[![License][license-src]][license-href]
8+
9+
> HTML validation using [html-validate](https://html-validate.org/) for [NuxtJS](https://nuxtjs.org)
10+
11+
- [✨ &nbsp;Release Notes](https://html-validator.nuxtjs.org/releases)
12+
- [📖 &nbsp;Documentation](https://html-validator.nuxtjs.org)
13+
14+
## Features
15+
16+
- Zero-configuration required
17+
- Helps reduce hydration errors
18+
- Detects common accessibility mistakes
19+
20+
[📖 &nbsp;Read more](https://html-validator.nuxtjs.org)
21+
22+
## Quick setup
23+
24+
1. Add `@nuxtjs/html-validator` dependency to your project
25+
26+
```bash
27+
yarn add @nuxtjs/html-validator # or npm install @nuxtjs/html-validator
28+
```
29+
30+
2. Add `@nuxtjs/html-validator` to the `modules` section of `nuxt.config.js`
31+
32+
```js
33+
{
34+
buildModules: [
35+
'@nuxtjs/html-validator',
36+
],
37+
}
38+
```
39+
40+
## Development
41+
42+
1. Clone this repository
43+
2. Install dependencies using `yarn install`
44+
3. Start development server using `yarn dev`
45+
46+
## License
47+
48+
[MIT License](./LICENSE)
49+
50+
<!-- Badges -->
51+
[npm-version-src]: https://img.shields.io/npm/v/@nuxtjs/html-validator/latest.svg
52+
[npm-version-href]: https://npmjs.com/package/@nuxtjs/html-validator
53+
54+
[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxtjs/html-validator.svg
55+
[npm-downloads-href]: https://npmjs.com/package/@nuxtjs/html-validator
56+
57+
[github-actions-ci-src]: https://github.com/nuxt-community/html-validator-module/workflows/ci/badge.svg
58+
[github-actions-ci-href]: https://github.com/nuxt-community/html-validator-module/actions?query=workflow%3Aci
59+
60+
[codecov-src]: https://img.shields.io/codecov/c/github/nuxt-community/html-validator-module.svg
61+
[codecov-href]: https://codecov.io/gh/nuxt-community/html-validator-module
62+
63+
[license-src]: https://img.shields.io/npm/l/@nuxtjs/html-validator.svg
64+
[license-href]: https://npmjs.com/package/@nuxtjs/html-validator

‎docs/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
static/sw.js

0 commit comments

Comments
 (0)