Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add vale to project #797

Merged
merged 59 commits into from
Jan 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
59 commits
Select commit Hold shift + click to select a range
c1dfc13
docs: add vale to project
TC-MO Dec 19, 2023
d3a9d60
fix dir path
TC-MO Dec 19, 2023
c4ec376
fix to dir path
TC-MO Dec 19, 2023
f6551dc
change files to lint
TC-MO Dec 20, 2023
1d48e3a
remove __onlymodified flag
TC-MO Dec 20, 2023
d5a682f
fix path & fix typo
TC-MO Dec 20, 2023
a1af8f5
revert changes to fail_on_error & add new filter
TC-MO Dec 20, 2023
36f86db
test rewrite with vale error
TC-MO Dec 20, 2023
d16e53e
test - fix vale error
TC-MO Dec 20, 2023
27f0192
add get changed files action
TC-MO Dec 20, 2023
b7778c3
add required token var
TC-MO Dec 20, 2023
25a4430
fix gh action version
TC-MO Dec 20, 2023
f9760a5
fix typo
TC-MO Dec 20, 2023
aa44d1a
test - vale error
TC-MO Dec 20, 2023
de5219f
change run rules
TC-MO Dec 20, 2023
c9ed0a5
fix typos
TC-MO Dec 20, 2023
498cebd
test - vale error fix
TC-MO Dec 20, 2023
967ce66
add Microsoft Style Guide
TC-MO Dec 21, 2023
04f724d
turn off quotes rules
TC-MO Dec 21, 2023
002dcd4
vale test msoft rules
TC-MO Dec 21, 2023
bc1383a
vale - test
TC-MO Dec 21, 2023
662f0dd
Merge branch 'master' into setup-vale
TC-MO Dec 21, 2023
9a2736c
add proselint for testing purposes
TC-MO Dec 21, 2023
3e2f575
remove proselint from vale.ini
TC-MO Dec 21, 2023
d734652
remove vale setup for testing
TC-MO Dec 21, 2023
a69ef4a
add vale setup for testing
TC-MO Dec 21, 2023
95f0552
remove styles dir
TC-MO Dec 21, 2023
479bda0
add styles dir to gitignore
TC-MO Dec 21, 2023
8748746
test - change branch of action
TC-MO Dec 21, 2023
91689ce
revert change action branch
TC-MO Dec 21, 2023
63c2829
remove unnecessary filter mode from action workflow
TC-MO Dec 21, 2023
a2db4f6
change steps to get modified, added & renamed files
TC-MO Dec 21, 2023
43a046c
test __onlyModified flag instead of separate gh action
TC-MO Dec 21, 2023
ec4e9db
change approach to change files generation
TC-MO Dec 21, 2023
1c09399
change approach to changed files generation
TC-MO Dec 21, 2023
05d1726
fix vale errors
TC-MO Dec 21, 2023
58c4249
remove Microsoft package
TC-MO Dec 21, 2023
94f3a66
remove unnecassary rule disable
TC-MO Dec 21, 2023
f246ce7
test new approach with files filtering
TC-MO Dec 22, 2023
57814c6
fix typo
TC-MO Dec 22, 2023
a9d8020
fix test workflow
TC-MO Dec 22, 2023
17980f1
changes to Contributing.md
TC-MO Dec 22, 2023
ad18340
test changes to withing sources dir
TC-MO Dec 22, 2023
f272c66
test action
TC-MO Dec 22, 2023
75b2f11
vale test
TC-MO Dec 22, 2023
3c9985b
revert changes to vale workflow
TC-MO Dec 22, 2023
6be2307
fix contributing.md vale errors
TC-MO Dec 22, 2023
8a9982d
vale action test
TC-MO Dec 22, 2023
2f64a08
fix symbol
TC-MO Dec 22, 2023
ee298b7
add test error
TC-MO Dec 22, 2023
8292ddd
add fetch-depth
TC-MO Dec 22, 2023
599840b
fix vale error
TC-MO Dec 22, 2023
d0f6e02
add reporter flag to reviewdog
TC-MO Dec 22, 2023
85e30a5
change reporter flag
TC-MO Dec 22, 2023
9a47676
Revert "change reporter flag"
TC-MO Dec 22, 2023
37f3a69
.
TC-MO Dec 22, 2023
48712af
add msoft styleguide to vale.ini
TC-MO Jan 5, 2024
a93dfd1
turn off few unnecessary msoft style guide rules & add info regarding…
TC-MO Jan 5, 2024
b674ed7
Merge branch 'master' into setup-vale
TC-MO Jan 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ trim_trailing_whitespace = true
insert_final_newline = true
end_of_line = lf
# editorconfig-tools is unable to ignore longs strings or urls
max_line_length = null
max_line_length = 0
quote_type = single
10 changes: 10 additions & 0 deletions .github/styles/Apify/Apify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: substitution
message: "Use '%s' instead of '%s'."
ignorecase: false
level: warning
swap:
Apify Dashboard: Apify Console
apify freelancers: Apify freelancers
Apify Platfrom: Apify platform
'(?:[Tt]he\s)?[Aa]pify\sproxy': Apify Proxy
circa: approx.
9 changes: 9 additions & 0 deletions .github/styles/Apify/Capitalization.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: "The word '%s' should always be capitalized."
ignorecase: false
level: error
tokens:
- '\bactor\b'
- '\bactors\b'
- '\bapify\b(?!-\w+)'
nonword: false
10 changes: 10 additions & 0 deletions .github/styles/Apify/Languages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: substitution
message: "Use '%s' instead of '%s'."
ignorecase: false
level: warning
swap:
'javascript|Javascript|javaScript': JavaScript
'(?<!-)python(?!-)': Python
'typescript|Typescript|typescript': TypeScript
'nodejs|Nodejs|node.js': Node.js
# Add more languages or common mistakes as needed
9 changes: 9 additions & 0 deletions .github/styles/Microsoft/AMPM.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
extends: existence
message: Use 'AM' or 'PM' (preceded by a space).
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/date-time-terms
level: error
nonword: true
tokens:
- '\d{1,2}[AP]M'
- '\d{1,2} ?[ap]m'
- '\d{1,2} ?[aApP]\.[mM]\.'
25 changes: 25 additions & 0 deletions .github/styles/Microsoft/Accessibility.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
extends: existence
message: "Don't use language (such as '%s') that defines people by their disability."
link: https://docs.microsoft.com/en-us/style-guide/a-z-word-list-term-collections/term-collections/accessibility-terms
level: suggestion
ignorecase: true
tokens:
- a victim of
- able-bodied
- affected by
- an epileptic
- crippled
- disabled
- dumb
- handicapped
- handicaps
- healthy
- lame
- maimed
- missing a limb
- mute
- normal
- sight-impaired
- stricken with
- suffers from
- vision-impaired
64 changes: 64 additions & 0 deletions .github/styles/Microsoft/Acronyms.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
extends: conditional
message: "'%s' has no definition."
link: https://docs.microsoft.com/en-us/style-guide/acronyms
level: suggestion
ignorecase: false
# Ensures that the existence of 'first' implies the existence of 'second'.
first: '\b([A-Z]{3,5})\b'
second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
# ... with the exception of these:
exceptions:
- API
- ASP
- CLI
- CPU
- CSS
- CSV
- DEBUG
- DOM
- DPI
- FAQ
- GCC
- GDB
- GET
- GPU
- GTK
- GUI
- HTML
- HTTP
- HTTPS
- IDE
- JAR
- JSON
- JSX
- LESS
- LLDB
- NET
- NOTE
- NVDA
- OSS
- PATH
- PDF
- PHP
- POST
- RAM
- REPL
- RSA
- SCM
- SCSS
- SDK
- SQL
- SSH
- SSL
- SVG
- TBD
- TCP
- TODO
- URI
- URL
- USB
- UTF
- XML
- XSS
- YAML
- ZIP
Loading