Skip to content

Commit

Permalink
Add initial version of the style, instructions, and GA config.
Browse files Browse the repository at this point in the history
  • Loading branch information
jtiee committed Apr 27, 2023
1 parent 24ac8f1 commit 8c4cf8a
Show file tree
Hide file tree
Showing 20 changed files with 469 additions and 3 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Build vale-style-JTI release
on: push
permissions:
contents: write
jobs:
build-style:
name: Build style
runs-on: ubuntu-latest
steps:
- name: Checkout style
uses: actions/checkout@v3
- name: Setup ENV
run: |
echo "RELEASE_VERSION=${GITHUB_REF#refs/*/}" >> $GITHUB_ENV
echo "RELEASE_SHA=${{ github.sha }}" >> $GITHUB_ENV
echo "REPO_NAME=${GITHUB_REPOSITORY}" >> $GITHUB_ENV
echo "REPO_URL=${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" >> $GITHUB_ENV
- name: Make ZIP
run: zip -r vale-style-JTI JTI
- name: Create release
uses: ncipollo/[email protected]
with:
artifacts: "vale-style-JTI.zip"
allowUpdates: true
generateReleaseNotes: true
tag: latest
token: ${{ secrets.GITHUB_TOKEN }}
126 changes: 126 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# Next.js build output
.next

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and *not* Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# macOS
.DS_Store

# Vim
*.swp
*.swo

# Antora
/adt
/build
/dictionaries/README_en_US-large.txt
/dictionaries/en_US-large.dic
/dictionaries/en_US-large.aff
/dictionaries/antora.dic
/dictionaries/antora.aff
/ecourt-ui.zip
/Makefile
/tmp

# Ruby
.bundle
5 changes: 5 additions & 0 deletions JTI/Button.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
message: "'%s' left in text"
extends: existence
level: error
raw:
- 'btn:'
5 changes: 5 additions & 0 deletions JTI/Fixme.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
message: "'%s' left in text"
extends: existence
level: error
tokens:
- FIXME
46 changes: 46 additions & 0 deletions JTI/Headings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
extends: capitalization
message: "'%s' should use sentence-style capitalization."
link: 'https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings'
level: warning
scope: heading
match: $sentence
indicators:
- ':'
exceptions:
- Azure
- CLI
- Client
- Code
- Cosmos
- Cygwin
- Docker
- Emmet
GitHub
- Host
- Integration
- Java
- JCMS
- Kubernetes
- Linux
- Maven
- MSSQL
- Marketplace
- Microsoft
- MongoDB
- MySQL
- REPL
- Server
- Studio
- Tomcat
- TypeScript
- URLs
- VS
- Visual
- Windows
- eAttorney
- eDMV
- eDefender
- eProsector
- eSeries
- gRPC
- macOS
5 changes: 5 additions & 0 deletions JTI/Image.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
message: "'%s' left in text"
extends: existence
level: error
raw:
- 'image:'
16 changes: 16 additions & 0 deletions JTI/Language.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
extends: substitution
message: "Use '%s' instead of '%s'."
ignorecase: true
level: error
nonword: true
action:
name: replace
swap:
ad hoc: informally
ergo: therefore
etc\.: and more
\bvia\b: using
vice versa: the other way around
(?:vis a vis|vis a vie): such as
vs\.: compared to
whilst: while
5 changes: 5 additions & 0 deletions JTI/Link.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
message: "'%s' left in text"
extends: existence
level: error
raw:
- 'link:'
5 changes: 5 additions & 0 deletions JTI/Menu.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
message: "'%s' left in text"
extends: existence
level: error
raw:
- 'menu:.*\['
26 changes: 26 additions & 0 deletions JTI/Needless.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
extends: existence
message: "Don't use needless words such as '%s'."
ignorecase: true
level: error
tokens:
- actually
- always
- basically
- both
- certain
- completely
- definitely
- either
- essentially
- just
- particular
- please
- quite
- really
- respective
- respectively
- simply
- specifically
- specified
- totally
- very
10 changes: 10 additions & 0 deletions JTI/Person.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
extends: existence
message: "Try to avoid using first-person plural like '%s'."
level: error
ignorecase: false
tokens:
- ours?
- us
- let's
- Ours?
- Let's
26 changes: 26 additions & 0 deletions JTI/Phrase.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
extends: existence
message: "Do not use phrases such as '%s'."
level: error
ignorecase: true
tokens:
- and so on
- a number of
- a result of
- as well as
- at present
- at this point
- be sure to
- by means of
- check out
- click on
- different than
- for instance
- in order to
- in the event of
- is unable
- of course
- place the
- shows up
- the manager
- variety of
- with respect to
55 changes: 55 additions & 0 deletions JTI/Simplify.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
extends: existence
message: "Simplify the word '%s'."
level: error
ignorecase: true
tokens:
- accomplish
- additionally
- additional
- alternatively
- alter
- appear
- appears
- approximately
- assist
- attempt
- automatically
- begin
- beneath
- breakthrough
- complicated
- concerning
- consult
- containing
- contain
- contains
- demonstrate
- determine
- difficult
- entire
- having
- highlights
- however
- illustrates
- immediately
- innovative
- locate
- major
- modification
- modifies
- modify
- necessary
- obtain
- operate
- perform
- pertains
- portion
- portions
- principle
- provide
- receive
- remainder
- robust
- upon
- whenever
- within
8 changes: 8 additions & 0 deletions JTI/Spelling.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
extends: spelling
message: "'%s'?"
dicpath: dictionaries
dictionaries:
- en_US-large
- antora
- local
level: error
Loading

0 comments on commit 8c4cf8a

Please sign in to comment.