diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..b0556b0 --- /dev/null +++ b/.github/workflows/build.yml @@ -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/release-action@v1.12.0 + with: + artifacts: "vale-style-JTI.zip" + allowUpdates: true + generateReleaseNotes: true + tag: latest + token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..6d572c2 --- /dev/null +++ b/.gitignore @@ -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 diff --git a/JTI/Button.yml b/JTI/Button.yml new file mode 100644 index 0000000..7f4986d --- /dev/null +++ b/JTI/Button.yml @@ -0,0 +1,5 @@ +message: "'%s' left in text" +extends: existence +level: error +raw: + - 'btn:' diff --git a/JTI/Fixme.yml b/JTI/Fixme.yml new file mode 100644 index 0000000..5ab6e6f --- /dev/null +++ b/JTI/Fixme.yml @@ -0,0 +1,5 @@ +message: "'%s' left in text" +extends: existence +level: error +tokens: + - FIXME diff --git a/JTI/Headings.yml b/JTI/Headings.yml new file mode 100644 index 0000000..878a550 --- /dev/null +++ b/JTI/Headings.yml @@ -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 diff --git a/JTI/Image.yml b/JTI/Image.yml new file mode 100644 index 0000000..82e106b --- /dev/null +++ b/JTI/Image.yml @@ -0,0 +1,5 @@ +message: "'%s' left in text" +extends: existence +level: error +raw: + - 'image:' diff --git a/JTI/Language.yml b/JTI/Language.yml new file mode 100644 index 0000000..4ee59f9 --- /dev/null +++ b/JTI/Language.yml @@ -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 diff --git a/JTI/Link.yml b/JTI/Link.yml new file mode 100644 index 0000000..0fd1021 --- /dev/null +++ b/JTI/Link.yml @@ -0,0 +1,5 @@ +message: "'%s' left in text" +extends: existence +level: error +raw: + - 'link:' diff --git a/JTI/Menu.yml b/JTI/Menu.yml new file mode 100644 index 0000000..12dc3b5 --- /dev/null +++ b/JTI/Menu.yml @@ -0,0 +1,5 @@ +message: "'%s' left in text" +extends: existence +level: error +raw: + - 'menu:.*\[' diff --git a/JTI/Needless.yml b/JTI/Needless.yml new file mode 100644 index 0000000..c7b5fec --- /dev/null +++ b/JTI/Needless.yml @@ -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 diff --git a/JTI/Person.yml b/JTI/Person.yml new file mode 100644 index 0000000..1d37a87 --- /dev/null +++ b/JTI/Person.yml @@ -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 diff --git a/JTI/Phrase.yml b/JTI/Phrase.yml new file mode 100644 index 0000000..8e5616f --- /dev/null +++ b/JTI/Phrase.yml @@ -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 diff --git a/JTI/Simplify.yml b/JTI/Simplify.yml new file mode 100644 index 0000000..eb4dfbe --- /dev/null +++ b/JTI/Simplify.yml @@ -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 diff --git a/JTI/Spelling.yml b/JTI/Spelling.yml new file mode 100644 index 0000000..d8669f1 --- /dev/null +++ b/JTI/Spelling.yml @@ -0,0 +1,8 @@ +extends: spelling +message: "'%s'?" +dicpath: dictionaries +dictionaries: + - en_US-large + - antora + - local +level: error diff --git a/JTI/Substitutions.yml b/JTI/Substitutions.yml new file mode 100644 index 0000000..d373d38 --- /dev/null +++ b/JTI/Substitutions.yml @@ -0,0 +1,41 @@ +extends: substitution +message: Use '%s' instead of '%s'. +level: error +ignorecase: true +swap: + '(?:LetsEncrypt|Let''s Encrypt)': Let's Encrypt + '(?:ReHat|RedHat)': RedHat + 'Mac ?OS ?X': Mac OS X + 'node[.]?js': Node.js + 'Post?gr?e(?:SQL)': PostgreSQL + # 'java[ -]?scripts?': JavaScript + automattic: Automattic + centOS: CentOS + cloudflare: Cloudflare + debian: Debian + fedora: Fedora + gentoo: Gentoo + '(?:[^-])github': GitHub + gitlab: GitLab + homebrew: Homebrew + Intellij: IntelliJ + JAMstack: Jamstack + Mac OS: macOS + metabase: Metabase + nodebalancer: NodeBalancer + nodebalancers: NodeBalancers + openSUSE: OpenSUSE + slackware: Slackware + ubuntu: Ubuntu + wordpress: WordPress + wundergraph: WunderGraph + yaml: YAML + url: URL + uri: URI + urls: URLs + uris: URIs + data-set: dataset + "data set": dataset + data-sets: datasets + "data sets": datasets + time-out: timeout diff --git a/JTI/Tense.yml b/JTI/Tense.yml new file mode 100644 index 0000000..a1bd315 --- /dev/null +++ b/JTI/Tense.yml @@ -0,0 +1,11 @@ +extends: existence +message: "Avoid past and future tenses such as '%s'." +ignorecase: true +level: error +tokens: + - will + - was + - has been + - have been + - had been + - would be diff --git a/JTI/Xref.yml b/JTI/Xref.yml new file mode 100644 index 0000000..4c1a2ff --- /dev/null +++ b/JTI/Xref.yml @@ -0,0 +1,5 @@ +message: "'%s' left in text" +extends: existence +level: error +raw: + - 'xref:' diff --git a/LICENSE b/LICENSE index 5bf0df6..c933d19 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Ewan Edwards +Copyright (c) 2023 Journal Technologies, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..f1e221a --- /dev/null +++ b/README.adoc @@ -0,0 +1,46 @@ += vale-style-JTI + +A Vale style for Journal Technologies, Inc. (JTI) documentation. + +NOTE: This project is neither maintained or endorsed by + https://github.com/errata-ai/[errata-ai^]. + + +== Usage + +There are two ways to use this style: + +1. Download the https://github.com/jtiee/vale-style-JTI/releases[latest +release^], copy the `JTI` folder to your Vale `StylesPath`, and include +it in your `.vale.ini` configuration file: ++ +[source, ini] +---- +# This goes in a file named either `.vale.ini` or `_vale.ini`. +StylesPath = path/to/some/directory +MinAlertLevel = warning # suggestion, warning or error + +# Only Asciidoc and .txt files; change to whatever you're using. +[*.{adoc,txt}] +# List of styles to load. +BasedOnStyles = JTI +---- + +2. Add the repo URL to your Vale `Packages` in your `.vale.ini` +configuration file: + + +[source, ini] +---- +# This goes in a file named either `.vale.ini` or `_vale.ini`. +StylesPath = path/to/some/directory +MinAlertLevel = warning # suggestion, warning or error + +Packages = Google, \ +https://github.com/jtiee/vale-style-JTI/releases/download/latest/vale-style-JTI.zip + +# Only Asciidoc and .txt files; change to whatever you're using. +[*.{adoc,txt}] +# List of styles to load. +BasedOnStyles = JTI +---- diff --git a/README.md b/README.md deleted file mode 100644 index 3dca78d..0000000 --- a/README.md +++ /dev/null @@ -1,2 +0,0 @@ -# vale-style-JTI -A Vale style for Journal Technologies documentation.