Skip to content

Commit 57fcc43

Browse files
committed
feat(init): initial commit
1 parent a8dd5e3 commit 57fcc43

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+12472
-2
lines changed

.branchlintrc

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
{
2+
"branchNameLinter": {
3+
"prefixes": [
4+
"feature",
5+
"hotfix",
6+
"release",
7+
"renovate",
8+
"beta",
9+
"next"
10+
],
11+
"suggestions": {
12+
"features": "feature",
13+
"feat": "feature",
14+
"fix": "hotfix",
15+
"releases": "release"
16+
},
17+
"banned": [
18+
"wip"
19+
],
20+
"skip": [
21+
"skip-ci"
22+
],
23+
"disallowed": [
24+
"main",
25+
"master",
26+
"next",
27+
"staging"
28+
],
29+
"seperator": "/",
30+
"msgBranchBanned": "Branches with the name \"%s\" are not allowed.",
31+
"msgBranchDisallowed": "Pushing to \"%s\" is not allowed, use git-flow.",
32+
"msgPrefixNotAllowed": "Branch prefix \"%s\" is not allowed.",
33+
"msgPrefixSuggestion": "Instead of \"%s\" try \"%s\".",
34+
"msgSeperatorRequired": "Branch \"%s\" must contain a seperator \"%s\"."
35+
}
36+
}

.editorconfig

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

.gitignore

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
.history
15+
16+
# Editor directories and files
17+
.vscode/*
18+
!.vscode/extensions.json
19+
.idea
20+
.DS_Store
21+
*.suo
22+
*.ntvs*
23+
*.njsproj
24+
*.sln
25+
*.sw?
26+
27+
# docs
28+
docs/.vitepress/dist
29+
docs/.vitepress/cache

.husky/commit-msg

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/sh
2+
3+
export NVM_DIR="$HOME/.nvm"
4+
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
5+
6+
npx --no-install commitlint --edit $1

.husky/pre-commit

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/sh
2+
3+
export NVM_DIR="$HOME/.nvm"
4+
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
5+
6+
npx --no-install lint-staged

.husky/pre-push

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
#!/bin/sh
2+
3+
export NVM_DIR="$HOME/.nvm"
4+
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"
5+
6+
npx branch-name-lint .branchlintrc

.lintstagedrc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"*.(js|vue)": [
3+
"npm run lint:es"
4+
]
5+
}

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
20.15.0

.prettierrc.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
export default {
2+
arrowParens: 'avoid',
3+
bracketSameLine: true,
4+
trailingComma: 'none',
5+
singleQuote: true,
6+
semi: true,
7+
printWidth: 120
8+
};

.releaserc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"branches": [
3+
{
4+
"name": "main",
5+
"channel": "latest",
6+
"prerelease": false
7+
},
8+
{
9+
"name": "beta",
10+
"prerelease": true
11+
},
12+
{
13+
"name": "next",
14+
"prerelease": true
15+
}
16+
],
17+
"plugins": [
18+
"@semantic-release/commit-analyzer",
19+
"@semantic-release/release-notes-generator",
20+
[
21+
"@semantic-release/changelog",
22+
{
23+
"changelogFile": "CHANGELOG.md",
24+
"changelogTitle": "# Project Changelog"
25+
}
26+
],
27+
[
28+
"@semantic-release/npm"
29+
],
30+
[
31+
"@semantic-release/git",
32+
{
33+
"assets": [
34+
"CHANGELOG.md",
35+
"CHANGELOG_PROJECT.md",
36+
"package.json",
37+
"package-lock.json",
38+
"npm-shrinkwrap.json"
39+
]
40+
}
41+
],
42+
[
43+
"@semantic-release/github"
44+
]
45+
]
46+
}

.stylelintignore

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Common
2+
node_modules
3+
dist
4+
.nuxt
5+
coverage
6+
.reports
7+
.history
8+
9+
# Files
10+
**/*.js
11+
src/runtime/tmpl/fonts.css
12+
13+
# docs
14+
docs/.vitepress/dist
15+
docs/.vitepress/cache

.stylelintrc

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
{
2+
"extends": [
3+
"stylelint-config-standard",
4+
"stylelint-config-recess-order"
5+
],
6+
"customSyntax": "postcss-html",
7+
"ignoreFiles": [
8+
"./**/*.js"
9+
],
10+
"rules": {
11+
"no-descending-specificity": null,
12+
"value-keyword-case": [
13+
"lower",
14+
{
15+
"camelCaseSvgKeywords": true
16+
}
17+
],
18+
"function-no-unknown": [
19+
true,
20+
{
21+
"ignoreFunctions": [
22+
"lost-vars",
23+
"em",
24+
"vw"
25+
]
26+
}
27+
],
28+
"selector-pseudo-class-no-unknown": [
29+
true,
30+
{
31+
"ignorePseudoClasses": [
32+
"global",
33+
"deep"
34+
]
35+
}
36+
],
37+
"selector-pseudo-element-no-unknown": [
38+
true,
39+
{
40+
"ignorePseudoElements": [
41+
"v-deep"
42+
]
43+
}
44+
]
45+
}
46+
}

.vscode/extensions.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"recommendations": ["Vue.volar"]
3+
}

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team (<[email protected]>, <[email protected]>). All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
<https://www.contributor-covenant.org/faq>

CONTRIBUTING.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Contributing to Vue Semantic Strucure
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Develop with Github
12+
13+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
17+
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `master`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Issue that pull request!
25+
26+
## Any contributions you make will be under the MIT Software License
27+
28+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
29+
30+
## Report bugs using Github's [issues](https://github.com/basics/vue-semantic-structure/issues)
31+
32+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/basics/vue-semantic-structure/issues/new/choose); it's that easy!
33+
34+
## Write bug reports with detail, background, and sample code
35+
36+
**Great Bug Reports** tend to have:
37+
38+
- A quick summary and/or background
39+
- Steps to reproduce
40+
- Be specific!
41+
- Give sample code if you can.
42+
- What you expected would happen
43+
- What actually happens
44+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
45+
46+
People *love* thorough bug reports. I'm not even kidding.
47+
48+
## License
49+
50+
By contributing, you agree that your contributions will be licensed under its MIT License.
51+
52+
## References
53+
54+
This document was adapted from the open-source contribution guidelines from [Brian A. Danielak](https://gist.github.com/briandk/3d2e8b3ec8daf5a27a62)

0 commit comments

Comments
 (0)