Skip to content

Commit 57706c7

Browse files
castastrophecastastrophe
committed
chore: add markdownlint and format component changelogs (#3587)
* chore: add markdownlint and format component changelogs
1 parent 7797847 commit 57706c7

File tree

108 files changed

+9155
-31809
lines changed

Some content is hidden

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

108 files changed

+9155
-31809
lines changed

‎.eslintrc

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,30 @@
144144
]
145145
}
146146
},
147+
{
148+
"files": ["tokens/dist/**/*.json"],
149+
"rules": {
150+
"jsonc/sort-keys": [
151+
"warn",
152+
{
153+
"pathPattern": "^$",
154+
"order": { "type": "asc" }
155+
},
156+
{
157+
"pathPattern": ".*",
158+
"order": [
159+
"prop",
160+
"ref",
161+
"value",
162+
"light",
163+
"dark",
164+
"medium",
165+
"large"
166+
]
167+
}
168+
]
169+
}
170+
},
147171
{
148172
"files": [
149173
"components/*/stories/*.js",

‎.github/actions/file-diff/CHANGELOG.md

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -4,88 +4,75 @@
44

55
### Minor Changes
66

7-
- [`205182b`](https://github.com/adobe/spectrum-css/commit/205182bebcbe82813457aa098d8799b0a23423ee) Thanks [@castastrophe](https://github.com/castastrophe)!
7+
📝 [`205182b`](https://github.com/adobe/spectrum-css/commit/205182bebcbe82813457aa098d8799b0a23423ee) Thanks [@castastrophe](https://github.com/castastrophe)!
8+
89
- New feature: report on minified and gzipped sizes for existing compiled outputs
910

1011
## 2.1.0
1112

1213
### Minor Changes
1314

14-
- [#3488](https://github.com/adobe/spectrum-css/pull/3488) [`40c1954`](https://github.com/adobe/spectrum-css/commit/40c1954048f735a07f9edfccf3a568d38164806a) Thanks [@castastrophe](https://github.com/castastrophe)!
15+
📝 [#3488](https://github.com/adobe/spectrum-css/pull/3488) [`40c1954`](https://github.com/adobe/spectrum-css/commit/40c1954048f735a07f9edfccf3a568d38164806a) Thanks [@castastrophe](https://github.com/castastrophe)!
16+
1517
- Update file table to specify if the file is deleted/moved and indicate the file size has decreased without showing percentages. This update also hardens the way in which the main file is highlighted in the table by checking for exact equals for looking for files "ending with" the file name.
1618

1719
## 2.0.6
1820

1921
### Patch Changes
2022

21-
- [#2775](https://github.com/adobe/spectrum-css/pull/2775) [`2452637`](https://github.com/adobe/spectrum-css/commit/2452637d1179b9b2b025dafeb5834720712413d7) Thanks [@castastrophe](https://github.com/castastrophe)!
22-
- Dependency minor and patch updates to support new features in tools leveraged
23+
📝 [#2775](https://github.com/adobe/spectrum-css/pull/2775) [`2452637`](https://github.com/adobe/spectrum-css/commit/2452637d1179b9b2b025dafeb5834720712413d7) Thanks [@castastrophe](https://github.com/castastrophe)!
2324

24-
<a name="2.0.5"></a>
25+
- Dependency minor and patch updates to support new features in tools leveraged
2526

26-
##2.0.5
27+
## 2.0.5
2728

2829
🗓 2024-03-07 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
2930

3031
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
3132

32-
<a name="2.0.4"></a>
33-
34-
##2.0.4
33+
## 2.0.4
3534

3635
🗓 2024-02-12 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
3736

3837
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
3938

40-
<a name="2.0.3"></a>
41-
42-
##2.0.3
39+
## 2.0.3
4340

44-
🗓 2024-02-06
41+
🗓 2024-02-06 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
4542

4643
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
4744

48-
<a name="2.0.2"></a>
49-
50-
##2.0.2
45+
## 2.0.2
5146

5247
🗓 2024-01-29 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
5348

5449
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
5550

56-
<a name="2.0.1"></a>
57-
58-
##2.0.1
51+
## 2.0.1
5952

6053
🗓 2024-01-16 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
6154

6255
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
6356

64-
<a name="2.0.0"></a>
65-
66-
#2.0.0
57+
## 2.0.0
6758

6859
🗓 2023-12-12 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
6960

7061
- feat(icon,ui-icons)!: migrate the icon compiler to a distinct package (#2343)([d73d594](https://github.com/adobe/spectrum-css/commit/d73d594)), closes[#2343](https://github.com/adobe/spectrum-css/issues/2343)
7162

72-
### 🛑 BREAKING CHANGES
63+
### 🛑 BREAKING CHANGE
7364

7465
- @spectrum-css/icon will no longer contain SVG assets; it will be a purely CSS package with all SVG assets migrated to the new @spectrum-css/ui-icons package.
7566

7667
- NEW: @spectrum-css/ui-icons package for all SVG icons in the UI set.
7768

78-
<a name="1.0.2"></a>
69+
## 1.0.2
7970

80-
##1.0.2
81-
82-
🗓 2023-11-15
71+
🗓 2023-11-15 • 📝 [Commits](https://github.com/adobe/spectrum-css/compare/@spectrum-tools/[email protected]...@spectrum-tools/[email protected])
8372

8473
**Note:** Version bump only for package @spectrum-tools/gh-action-file-diff
8574

86-
<a name="1.0.1"></a>
87-
88-
##1.0.1
75+
## 1.0.1
8976

9077
🗓 2023-11-13
9178

‎.github/workflows/development.yml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ jobs:
8585
styles_modified_files: ${{ steps.changed-files.outputs.styles_modified_files }}
8686
eslint_added_files: ${{ steps.changed-files.outputs.eslint_added_files }}
8787
eslint_modified_files: ${{ steps.changed-files.outputs.eslint_modified_files }}
88+
mdlint_added_files: ${{ steps.changed-files.outputs.mdlint_added_files }}
89+
mdlint_modified_files: ${{ steps.changed-files.outputs.mdlint_modified_files }}
8890
plugins_modified_files: ${{ steps.changed-files.outputs.plugins_modified_files }}
8991
plugins_added_files: ${{ steps.changed-files.outputs.plugins_added_files }}
9092
permissions:
@@ -102,6 +104,17 @@ jobs:
102104
- components/*/themes/express.css
103105
eslint:
104106
- components/*/stories/*.js
107+
mdlint:
108+
- *.md
109+
- .storybook/*.md
110+
- .storybook/*/*.md
111+
- .storybook/*/*.mdx
112+
- components/*/*.md
113+
- components/*/stories/*.mdx
114+
- plugins/*/*.md
115+
- tokens/*.md
116+
- tools/*/*.md
117+
- ui-icons/*.md
105118
plugins:
106119
- plugins/**/*
107120

‎.github/workflows/lint.yml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,12 @@ on:
1818
eslint_modified_files:
1919
type: string
2020
required: false
21+
mdlint_added_files:
22+
type: string
23+
required: false
24+
mdlint_modified_files:
25+
type: string
26+
required: false
2127
workflow_call:
2228
inputs:
2329
styles_added_files:
@@ -32,6 +38,12 @@ on:
3238
eslint_modified_files:
3339
type: string
3440
required: false
41+
mdlint_added_files:
42+
type: string
43+
required: false
44+
mdlint_modified_files:
45+
type: string
46+
required: false
3547

3648
permissions:
3749
contents: read
@@ -104,3 +116,12 @@ jobs:
104116
filter_mode: diff_context
105117
# eslint_flags: "components/*/stories/*.js"
106118
eslint_flags: "${{ inputs.eslint_added_files }} ${{ inputs.eslint_modified_files }}"
119+
120+
- name: Run markdownlint on documentation
121+
uses: reviewdog/[email protected]
122+
with:
123+
reporter: github-pr-review
124+
filter_mode: diff_context
125+
fail_level: error
126+
markdownlint_config: "${{ github.workspace }}/.markdownlint.json"
127+
markdownlint_input: "${{ inputs.mdlint_added_files }} ${{ inputs.mdlint_modified_files }}"

‎.markdownlint.json

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
{
2+
"extends": "markdownlint/style/prettier",
3+
"first-line-h1": false,
4+
"no-inline-html": false,
5+
"no-bare-urls": false,
6+
"no-duplicate-heading": {
7+
"siblings_only": true
8+
},
9+
"code-block-style": {
10+
"style": "fenced"
11+
},
12+
"code-fence-style": {
13+
"style": "backtick"
14+
},
15+
"emphasis-style": {
16+
"style": "underscore"
17+
},
18+
"strong-style": {
19+
"style": "asterisk"
20+
},
21+
"ul-style": {
22+
"style": "dash"
23+
}
24+
}

0 commit comments

Comments
 (0)