Restructure to meet vale style guidelines

ChrisChinchilla · Jan 26, 2021 · a686522 · a686522
1 parent 366c925
commit a686522
Show file tree

Hide file tree

Showing 49 changed files with 150 additions and 11 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -0,0 +1,27 @@
+language: python
+cache: bundler
+python:
+  - "3.6"
+install:
+  # Install the latest release of Vale:
+  - wget https://github.com/errata-ai/vale/releases/download/v2.0.0-beta.2/vale_2.0.0-beta.2_Linux_64-bit.tar.gz
+  - mkdir bin && tar -xvzf vale_2.0.0-beta.2_Linux_64-bit.tar.gz -C bin
+  - export PATH=./bin:"$PATH"
+
+  - bundle install --jobs=3
+
+  - pip install yamllint
+  - pip install markdata
+  - pip install pyyaml
+before_script:
+  - yamllint -c '.yamllint.yml' Openly
+script:
+  - cucumber
+  - zip -r Openly.zip Openly -x "*.DS_Store"
+deploy:
+  provider: releases
+  api_key: $GITHUB_TOKEN
+  file: Openly.zip
+  skip_cleanup: true
+  on:
+    tags: true
diff --git a/.yamllint.yml b/.yamllint.yml
@@ -0,0 +1,8 @@
+rules:
+  # We only include a single document (without directives) in our rules, so
+  # the extra markup is unnecessary.
+  document-start: disable
+  # Many rules include a `link` key that can be relatively long.
+  #
+  # TODO: Should we change this?
+  line-length: disable
diff --git a/Ages.yml b/Ages.yml
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,3 @@
+# Change Log
+
+<!-- TODO -->
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'aruba', '~> 0.14.3'
diff --git a/A11Y.yml → Openly/A11Y.yml b/A11Y.yml → Openly/A11Y.yml
diff --git a/Anthropomorphism.yml → Openly/Anthropomorphism.yml b/Anthropomorphism.yml → Openly/Anthropomorphism.yml
diff --git a/But.yml → Openly/But.yml b/But.yml → Openly/But.yml
diff --git a/Clarity.yml → Openly/Clarity.yml b/Clarity.yml → Openly/Clarity.yml
diff --git a/E-Prime.yml → Openly/E-Prime.yml b/E-Prime.yml → Openly/E-Prime.yml
diff --git a/FutureTense.yml → Openly/FutureTense.yml b/FutureTense.yml → Openly/FutureTense.yml
@@ -1,4 +1,3 @@
----
 extends: existence
 message: "Possible future tense."
 ignorecase: true

diff --git a/GenderBias.yml → Openly/GenderBias.yml b/GenderBias.yml → Openly/GenderBias.yml
diff --git a/HeadingsPunctuation.yml → Openly/HeadingsPunctuation.yml b/HeadingsPunctuation.yml → Openly/HeadingsPunctuation.yml
@@ -1,7 +1,7 @@
 ---
 extends: existence
 message: Do not use '%s' at the end of headings
-link: https://github.com/cockroachdb/docs/blob/master/STYLE.md#capitalization-and-punctuation
+link: https://github.com/Openly/docs/blob/master/STYLE.md#capitalization-and-punctuation
 scope: heading
 level: warning
 raw:

diff --git a/Hedging.yml → Openly/Hedging.yml b/Hedging.yml → Openly/Hedging.yml
diff --git a/Openly/Hyphens.yml b/Openly/Hyphens.yml
@@ -0,0 +1,17 @@
+---
+extends: substitution
+message: Use '%s' instead of '%s'
+level: warning
+swap:
+  African-American: African American
+  Asian-American: Asian American
+  All American: All-American
+  'campus(?:-|\s)wide': campuswide
+  'college(?:-|\s)wide': collegewide
+  'state(?:-|\s)wide': statewide
+  'world(?:-|\s)wide': worldwide
+  'change(?:-|\s)maker': change maker
+  e-mail: email
+  game-changer: game changer
+  Native-American: Native American
+  right click: right-click
diff --git a/Link.yml → Openly/Link.yml b/Link.yml → Openly/Link.yml
diff --git a/Punctuation.yml → Openly/Punctuation.yml b/Punctuation.yml → Openly/Punctuation.yml
diff --git a/QuoteType.yml → Openly/QuoteType.yml b/QuoteType.yml → Openly/QuoteType.yml
diff --git a/Quotes.yml → Openly/Quotes.yml b/Quotes.yml → Openly/Quotes.yml
diff --git a/Readability.yml → Openly/Readability.yml b/Readability.yml → Openly/Readability.yml
diff --git a/SentenceLength.yml → Openly/SentenceLength.yml b/SentenceLength.yml → Openly/SentenceLength.yml
diff --git a/So.yml → Openly/So.yml b/So.yml → Openly/So.yml
diff --git a/Spelling.yml → Openly/Spelling.yml b/Spelling.yml → Openly/Spelling.yml
diff --git a/ThereIs.yml → Openly/ThereIs.yml b/ThereIs.yml → Openly/ThereIs.yml
diff --git a/Titles.yml → Openly/Titles.yml b/Titles.yml → Openly/Titles.yml
diff --git a/UnclearAntecedent.yml → Openly/UnclearAntecedent.yml b/UnclearAntecedent.yml → Openly/UnclearAntecedent.yml
diff --git a/tech-terms/apis.txt → Openly/tech-terms/apis.txt b/tech-terms/apis.txt → Openly/tech-terms/apis.txt
diff --git a/tech-terms/blockchain.txt → Openly/tech-terms/blockchain.txt b/tech-terms/blockchain.txt → Openly/tech-terms/blockchain.txt
diff --git a/tech-terms/business.txt → Openly/tech-terms/business.txt b/tech-terms/business.txt → Openly/tech-terms/business.txt
diff --git a/tech-terms/csharp.txt → Openly/tech-terms/csharp.txt b/tech-terms/csharp.txt → Openly/tech-terms/csharp.txt
diff --git a/tech-terms/ddd.txt → Openly/tech-terms/ddd.txt b/tech-terms/ddd.txt → Openly/tech-terms/ddd.txt
diff --git a/tech-terms/devops.txt → Openly/tech-terms/devops.txt b/tech-terms/devops.txt → Openly/tech-terms/devops.txt
@@ -1,5 +1,6 @@
 kubernetes
 k8s
+kustomize
 kubectl
 docker
 rkt

diff --git a/tech-terms/general.txt → Openly/tech-terms/general.txt b/tech-terms/general.txt → Openly/tech-terms/general.txt
diff --git a/tech-terms/java.txt → Openly/tech-terms/java.txt b/tech-terms/java.txt → Openly/tech-terms/java.txt
diff --git a/tech-terms/linux.txt → Openly/tech-terms/linux.txt b/tech-terms/linux.txt → Openly/tech-terms/linux.txt
diff --git a/tech-terms/mobile.txt → Openly/tech-terms/mobile.txt b/tech-terms/mobile.txt → Openly/tech-terms/mobile.txt
diff --git a/tech-terms/monitoring.txt → Openly/tech-terms/monitoring.txt b/tech-terms/monitoring.txt → Openly/tech-terms/monitoring.txt
diff --git a/tech-terms/security.txt → Openly/tech-terms/security.txt b/tech-terms/security.txt → Openly/tech-terms/security.txt
diff --git a/Openly/tech-terms/tech-slang.txt b/Openly/tech-terms/tech-slang.txt
@@ -0,0 +1,2 @@
+n00b
+livestream
diff --git a/tech-terms/techwriting.txt → Openly/tech-terms/techwriting.txt b/tech-terms/techwriting.txt → Openly/tech-terms/techwriting.txt
@@ -3,4 +3,5 @@ linters
 documentarian
 markdown
 onboarding
-readme
+readme
+snagit
diff --git a/README.md b/README.md
@@ -1,3 +1,29 @@
 # Openly - Open source Grammarly
 
-This is a series of Vale styles to attempt to emulate some features of the commercial, and closed source, Grammarly. More to come.
+A Vale linter style that attempts to emulate some features of the commercial, and closed source, Grammarly. More to come.
+
+__Not complete, and WIP, contributions welcome__.😁
+
+
+[![Build Status](https://travis-ci.org/testthedocs/Openly.svg?branch=master)](https://travis-ci.org/testthedocs/Openly) ![Vale version](https://img.shields.io/badge/vale-%3E%3D%20v1.7.0-blue.svg) ![license](https://img.shields.io/github/license/mashape/apistatus.svg)
+
+This repository contains a [Vale-compatible](https://github.com/errata-ai/vale) that attempts to emulate some features of the commercial, and closed source, Grammarly. More to come.
+
+## Getting Started
+
+> :exclamation: Requires Vale >= **1.7.0**. :exclamation:
+
+Download the [latest release](https://github.com/testthedocs/Openly/releases), copy the "Openly" directory to your `StylesPath`, and include it in your configuration file:
+
+```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 Markdown and .txt files; change to whatever you're using.
+[*.{md,txt}]
+# List of styles to load.
+BasedOnStyles = Openly
+```
+
+See [Usage](https://github.com/errata-ai/vale/#usage) for more information.
diff --git a/features/rules.feature b/features/rules.feature
@@ -0,0 +1,14 @@
+Feature: Rules
+
+  Scenario: Basic test case
+    When I test "basic"
+    Then the output should contain exactly:
+      """
+      fail.md:3:7:Openly.Terminology:Prefer 'Openly' over 'Openly'
+      fail.md:3:19:Openly.Hyperbolic:Consider removing 'just'
+      fail.md:3:36:Openly.Spelling:Did you really mean 'eg'?
+      fail.md:3:36:Openly.Abbreviations:Use 'e.g.,' instead of 'eg'
+      fail.md:3:42:Openly.Spelling:Did you really mean 'ie'?
+      fail.md:3:42:Openly.Abbreviations:Use 'i.e.,' instead of 'ie'
+      fail.md:5:17:Openly.Spelling:Did you really mean 'spulling'?
+      """
diff --git a/features/steps.rb b/features/steps.rb
@@ -0,0 +1,6 @@
+cmd = 'vale --output=line --sort --normalize --relative'
+
+When(/^I test "(.*)"$/) do |rule|
+  step %(I cd to "../../fixtures/#{rule}")
+  step %(I run `#{cmd} .`)
+end
diff --git a/features/support/aruba.rb b/features/support/aruba.rb
@@ -0,0 +1 @@
+require 'aruba/cucumber'
diff --git a/fixtures/basic/.vale.ini b/fixtures/basic/.vale.ini
@@ -0,0 +1,6 @@
+StylesPath = ../../
+
+MinAlertLevel = suggestion
+
+[*.md]
+BasedOnStyles = Openly
diff --git a/fixtures/basic/fail.md b/fixtures/basic/fail.md
@@ -0,0 +1,13 @@
+# HEADINGS!
+
+So, click the button to see what the computer thinks they will say. There is also right click of course. This is true.
+
+But I'm telling you the truth is that it has the manpower and knows and arguably tries to assist you.
+
+And don't just link [here](#)
+
+What is eg? Do you mean example or two thirds of an egg? And you have to use "american quotes". Talking of quotes, we don't mind if you use "dumb" ones, or “smart” ones but keep it consistent.
+
+And try to keep your prose short, not have really really really long passages that go on and on for no real reason apart from to use lots of words.
+
+Don't make spulling mistakes, but certain technical terms such as nuget or linter are fine.
diff --git a/fixtures/basic/pass.md b/fixtures/basic/pass.md
@@ -0,0 +1,13 @@
+# Headings
+
+Click the button to see what the computer thinks. You can also use right click of course. This is true.
+
+But I'm telling you the truth is that it has the manpower and knows and arguably tries to assist you.
+
+Here is a link that [links to the documentation](#)
+
+What is e.g.? Do you mean example or two thirds of an egg? And you have to use "American quotes." Talking of quotes, we don't mind if you use "dumb" ones, or "smart" ones but keep it consistent.
+
+And try to keep your prose short.
+
+Don't make spelling mistakes, but certain technical terms such as nuget or linter are fine.
diff --git a/fixtures/basic/real.md b/fixtures/basic/real.md
@@ -0,0 +1,6 @@
+Hi.
+
+We'd like to hire an excellent java script guy, please.
+If you're good at javascript then please apply.
+
+Thank you.
diff --git a/tech-terms/tech-slang.txt b/tech-terms/tech-slang.txt
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		source 'https://rubygems.org'

		gem 'aruba', '~> 0.14.3'