Skip to content

Commit e87fcb2

Browse files
pengzhanbopengzhanbo
committed
chore: initial stylelint-codeguide 
0 parents  commit e87fcb2

File tree

10 files changed

+3312
-0
lines changed

10 files changed

+3312
-0
lines changed

‎.github/workflows/release.yml‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
name: Add Github Release Tag
2+
3+
permissions:
4+
contents: write
5+
6+
on:
7+
push:
8+
tags:
9+
- v*
10+
11+
jobs:
12+
release:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v3
16+
with:
17+
fetch-depth: 0
18+
19+
- uses: actions/setup-node@v3
20+
with:
21+
node-version: 18.x
22+
23+
- run: npx changelogithub
24+
env:
25+
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

‎.gitignore‎

Lines changed: 114 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,114 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
lerna-debug.log*
8+
9+
# Diagnostic reports (https://nodejs.org/api/report.html)
10+
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
11+
12+
# Runtime data
13+
pids
14+
*.pid
15+
*.seed
16+
*.pid.lock
17+
18+
# Directory for instrumented libs generated by jscoverage/JSCover
19+
lib-cov
20+
21+
# Coverage directory used by tools like istanbul
22+
coverage
23+
*.lcov
24+
25+
# nyc test coverage
26+
.nyc_output
27+
28+
# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
29+
.grunt
30+
31+
# Bower dependency directory (https://bower.io/)
32+
bower_components
33+
34+
# node-waf configuration
35+
.lock-wscript
36+
37+
# Compiled binary addons (https://nodejs.org/api/addons.html)
38+
build/Release
39+
40+
# Dependency directories
41+
node_modules/
42+
jspm_packages/
43+
.pnpm-store/
44+
45+
# TypeScript v1 declaration files
46+
typings/
47+
48+
# TypeScript cache
49+
*.tsbuildinfo
50+
51+
# Optional npm cache directory
52+
.npm
53+
54+
# Optional eslint cache
55+
.eslintcache
56+
57+
# Microbundle cache
58+
.rpt2_cache/
59+
.rts2_cache_cjs/
60+
.rts2_cache_es/
61+
.rts2_cache_umd/
62+
63+
# Optional REPL history
64+
.node_repl_history
65+
66+
# Output of 'npm pack'
67+
*.tgz
68+
69+
# Yarn Integrity file
70+
.yarn-integrity
71+
72+
# dotenv environment variables file
73+
.env
74+
.env.test
75+
76+
# parcel-bundler cache (https://parceljs.org/)
77+
.cache
78+
79+
# Next.js build output
80+
.next
81+
82+
# Nuxt.js build / generate output
83+
.nuxt
84+
dist
85+
86+
# Gatsby files
87+
.cache/
88+
# Comment in the public line in if your project uses Gatsby and *not* Next.js
89+
# https://nextjs.org/blog/next-9-1#public-directory-support
90+
# public
91+
92+
# yarn no zero-install
93+
.yarn/*
94+
!.yarn/patches
95+
!.yarn/releases
96+
!.yarn/plugins
97+
!.yarn/sdks
98+
!.yarn/versions
99+
.pnp.*
100+
101+
# vuepress build output
102+
.vuepress/dist
103+
104+
# Serverless directories
105+
.serverless/
106+
107+
# FuseBox cache
108+
.fusebox/
109+
110+
# DynamoDB Local files
111+
.dynamodb/
112+
113+
# TernJS port file
114+
.tern-port

‎.vscode/settings.json‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"cSpell.words": [
3+
"codeguide",
4+
"stylelintconfig"
5+
]
6+
}

‎CHANGELOG.md‎

Whitespace-only changes.

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 stylelint-types
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‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# @stylelint-types/stylelint-codeguide
2+
3+
TypeScript definitions for [stylelint-define-config](https://github.com/stylelint-types/stylelint-define-config).
4+
5+
## Install
6+
7+
```sh
8+
npm i -D @stylelint-types/stylelint-codeguide
9+
# or
10+
pnpm add -D @stylelint-types/stylelint-codeguide
11+
# or
12+
yarn add -D @stylelint-types/stylelint-codeguide
13+
```
14+
15+
## Usage
16+
17+
```js
18+
// @ts-check
19+
const defineConfig = require('stylelint-define-config')
20+
21+
/// <reference types="@stylelint-types/stylelint-codeguide" />
22+
23+
module.exports = defineConfig({
24+
rules: {
25+
// ...rules
26+
}
27+
})
28+
```
29+
30+
![](./static/demo.png)
31+
32+
## Credits
33+
34+
- [@stylelint-types](https://github.com/stylelint-types)
35+
- [@pengzhanbo](https://github.com/pengzhanbo)
36+
37+
## LICENSE
38+
39+
[MIT](./LICENSE)

‎eslint.config.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
import config from '@pengzhanbo/eslint-config'
2+
3+
export default config()

‎package.json‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
{
2+
"name": "@stylelint-types/stylelint-codeguide",
3+
"type": "module",
4+
"version": "0.0.0",
5+
"packageManager": "pnpm@8.11.0",
6+
"description": "TypeScript definitions for stylelint-define-config",
7+
"author": "pengzhanbo <volodymyr@foxmail.com> (https://github.com/pengzhanbo)",
8+
"license": "MIT",
9+
"homepage": "https://github.com/stylelint-types/stylelint-codeguide#readme",
10+
"repository": {
11+
"type": "git",
12+
"url": "https://github.com/stylelint-types/stylelint-codeguide.git"
13+
},
14+
"bugs": "https://github.com/stylelint-types/stylelint-codeguide/issues",
15+
"keywords": [
16+
"config",
17+
"scss",
18+
"configuration",
19+
"define-config",
20+
"stylelint-config",
21+
"stylelint",
22+
"stylelint-codeguide",
23+
"stylelintconfig",
24+
"typed",
25+
"typescript"
26+
],
27+
"exports": {
28+
".": {
29+
"types": "./lib/index.d.ts"
30+
},
31+
"./types": {
32+
"types": "./lib/types.d.ts"
33+
},
34+
"./package.json": "./package.json"
35+
},
36+
"main": "lib/index.d.ts",
37+
"files": [
38+
"lib"
39+
],
40+
"engines": {
41+
"node": ">=18.0.0",
42+
"npm": ">=9.0.0",
43+
"pnpm": ">=8.6.0"
44+
},
45+
"scripts": {
46+
"lint": "eslint .",
47+
"release:changelog": "conventional-changelog -p angular -i CHANGELOG.md -s",
48+
"release": "bumpp package.json --execute=\"pnpm release:changelog\" --commit --all --push --tag && pnpm publish --access public"
49+
},
50+
"peerDependencies": {
51+
"stylelint": ">=16.0.0",
52+
"stylelint-define-config": ">=1.0.0"
53+
},
54+
"peerDependenciesMeta": {
55+
"stylelint": {
56+
"optional": true
57+
}
58+
},
59+
"devDependencies": {
60+
"@pengzhanbo/eslint-config": "^1.3.2",
61+
"bumpp": "^9.2.1",
62+
"conventional-changelog-cli": "^4.1.0",
63+
"eslint": "^8.55.0",
64+
"stylelint": "^16.0.2",
65+
"stylelint-codeguide": "^1.0.2",
66+
"stylelint-define-config": "^1.0.1",
67+
"typescript": "^5.3.3"
68+
}
69+
}

0 commit comments

Comments
 (0)