Skip to content

Commit a0fc8e0

Browse files
committed
Add config files and update project metadata
Added .nvmrc, .prettierrc.json, .stylelintrc.json, CONTRIBUTING.md, and stackblitz.json for environment, formatting, linting, and contribution guidelines. Updated package.json with new project name, description, node engine requirement, scripts, and dependency versions to improve project setup and developer experience.
1 parent 2fb5662 commit a0fc8e0

6 files changed

Lines changed: 83 additions & 3 deletions

File tree

.nvmrc

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

.prettierrc.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"semi": true,
3+
"singleQuote": false,
4+
"tabWidth": 4,
5+
"useTabs": false,
6+
"trailingComma": "es5",
7+
"printWidth": 100,
8+
"bracketSpacing": true,
9+
"arrowParens": "always",
10+
"endOfLine": "lf",
11+
"htmlWhitespaceSensitivity": "css",
12+
"proseWrap": "preserve"
13+
}

.stylelintrc.json

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"extends": ["stylelint-config-standard-scss"],
3+
"rules": {
4+
"scss/at-rule-no-unknown": [
5+
true,
6+
{
7+
"ignoreAtRules": ["use", "forward", "import", "mixin", "include", "function", "return", "if", "else", "each", "for", "while", "extend"]
8+
}
9+
],
10+
"selector-class-pattern": null,
11+
"no-descending-specificity": null,
12+
"property-no-vendor-prefix": null,
13+
"value-no-vendor-prefix": null
14+
}
15+
}

CONTRIBUTING.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Contributing to Stylescape Examples
2+
3+
Thank you for your interest in contributing to Stylescape!
4+
5+
## Getting Started
6+
7+
1. Fork this repository
8+
2. Clone your fork locally
9+
3. Install dependencies: `npm install`
10+
4. Start development: `npm run dev`
11+
12+
## Guidelines
13+
14+
- Follow the existing code style
15+
- Test your changes locally before submitting
16+
- Keep commits focused and descriptive
17+
- Update documentation if needed
18+
19+
## Reporting Issues
20+
21+
- Check existing issues first
22+
- Provide clear reproduction steps
23+
- Include environment details (Node version, OS, browser)
24+
25+
## Pull Requests
26+
27+
1. Create a feature branch from `main` or `dev`
28+
2. Make your changes
29+
3. Test thoroughly
30+
4. Submit a PR with a clear description
31+
32+
## Code of Conduct
33+
34+
Please be respectful and inclusive. See our [Code of Conduct](.github/CODE_OF_CONDUCT.md).
35+
36+
## Questions?
37+
38+
- Open an issue for questions
39+
- Visit [Stylescape Documentation](https://github.com/stylescape/stylescape)
40+
41+
## License
42+
43+
By contributing, you agree that your contributions will be licensed under the MIT License.

package.json

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
11
{
2-
"name": "stylescape_webpack",
3-
"description": "Include Stylescape's source Sass and individual JavaScript plugins with Webpack.",
2+
"name": "stylescape-example-webpack",
3+
"description": "Stylescape example using Webpack bundler",
44
"version": "0.0.1",
55
"private": true,
66
"repository": "https://github.com/stylescape/example-webpack",
77
"license": "MIT",
8+
"engines": {
9+
"node": ">=22.0.0"
10+
},
811
"stackblitz": {
912
"startCommand": "npm start"
1013
},
1114
"scripts": {
15+
"dev": "webpack serve --mode development",
1216
"start": "webpack serve",
1317
"build": "webpack build --mode=production",
1418
"test": "npm run build"
1519
},
1620
"dependencies": {
17-
"stylescape": "^0.3.1"
21+
"stylescape": "^0.3.9"
1822
},
1923
"devDependencies": {
2024
"autoprefixer": "^10.4.23",

stackblitz.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"installDependencies": true,
3+
"startCommand": "npm run dev"
4+
}

0 commit comments

Comments
 (0)