Merge pull request #15 from 8fold/dual-syntax

Dual syntax

Author: joshbruce

.github/workflows/php.yml

@@ -1,31 +1,33 @@
-name: PHP Composer
+name: PHP 7.4
+
 on:
   push:
-    branches:
-      - master
+    branches: [main]
   pull_request:
-    branches:
-      - master
-
+    branches: [main]
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP Action
+        uses: shivammathur/[email protected]
+        with:
+          php-version: '7.4'
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
 
-    - name: Setup PHP Action
-      uses: shivammathur/[email protected]
-      with:
-        php-version: '7.4'
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
 
-    - name: Validate composer.json and composer.lock
-      run: composer validate
+      - name: Run style check
+        run: composer run style
 
-    - name: Install dependencies
-      run: composer install --prefer-dist --no-progress --no-suggest
+      - name: Run static analyzer
+        run: composer run stan
 
-    - name: Run test suite
-      run: vendor/bin/phpunit
+      - name: Run tests
+        run: composer run test

.github/workflows/php8.yml

@@ -1,31 +1,34 @@
-name: PHP Composer
+name: PHP 8.0
+
 on:
   push:
-    branches:
-      - master
+    branches: [main]
   pull_request:
-    branches:
-      - master
+    branches: [main]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
-
     steps:
-    - name: Checkout
-      uses: actions/checkout@v2
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup PHP Action
+        uses: shivammathur/[email protected]
+        with:
+          php-version: '8.0'
+
+      - name: Validate composer.json and composer.lock
+        run: composer validate
 
-    - name: Setup PHP Action
-      uses: shivammathur/[email protected]
-      with:
-        php-version: '8.0'
+      - name: Install dependencies
+        run: composer install --prefer-dist --no-progress
 
-    - name: Validate composer.json and composer.lock
-      run: composer validate
+      - name: Run style check
+        run: composer run style
 
-    - name: Install dependencies
-      run: composer install --prefer-dist --no-progress --no-suggest
+      - name: Run static analyzer
+        run: composer run stan
 
-    - name: Run test suite
-      run: vendor/bin/phpunit
+      - name: Run tests
+        run: composer run test

README.md

@@ -12,8 +12,26 @@ composer require 8fold/commonmark-abbreviations
 
 ## Usage
 
+
+
+## 2.1.0 to 3.0.0
+
+```markdown
+[.Eightfold](8fold)
+```
+
+Becomes:
+
+```html
+<abbr title="Eightfold">8fold</abbr>
+```
+
+You MAY also use the syntax prior to 2.1.0.
+
+## 2.0.0 and before
+
 ```markdown
-[.8fold](Eigtfold)
+[.8fold](Eightfold)
 ```
 
 Becomes:
@@ -38,11 +56,11 @@ We decided to go with inline, single instance over footer, replace-all.
 
 Two main options exist for implementing this capability.
 
-The first is to place the abbreviation and definition at the bottom of the document and render all occurences of the abbreviation with the `abbr` element and title. The drawback here is possible impact to readers using [.AT](Assistive Technology) like screen readers; potentially being read the full abbreviation each time.
+The first is to place the abbreviation and definition at the bottom of the document and render all occurrences of the abbreviation with the `abbr` element and title. The drawback here is possible impact to readers using [.AT](Assistive Technology) like screen readers; potentially being read the full abbreviation each time.
 
 The second option is to have the abbreviation be inline with the surrounding text. The drawback here is the need to write more each time an author uses the abbreviation.
 
-This library looks at Markdown as being a way of writing potentially rich-text documents first, which can be transformed into [.HTML](Hypertext Markup Language) or something else. The recomendation from the [[.US](United States) Plain Language Guidelines](https://plainlanguage.gov/resources/articles/keep-it-jargon-free/) is to avoid abbreviations and acronyms in general and specifically to:
+This library looks at Markdown as being a way of writing potentially rich-text documents first, which can be transformed into [.Hypertext Markup Language](HTML) or something else. The recommendation from the [[.US](United States) Plain Language Guidelines](https://plainlanguage.gov/resources/articles/keep-it-jargon-free/) is to avoid abbreviations and acronyms in general and specifically to:
 
 - Try to keep them to a maximum of two a page.
 - Use them if spelling them out would annoy your readers.

composer.json

@@ -14,7 +14,9 @@
     "league/commonmark": "^2.0.2"
   },
   "require-dev": {
-    "phpunit/phpunit": "^9.1"
+    "phpstan/phpstan": "^1.2.0",
+    "phpunit/phpunit": "^9.5",
+    "squizlabs/php_codesniffer": "^3.6"
   },
   "autoload": {
     "psr-4": {
@@ -31,6 +33,15 @@
     "preferred-install": "dist",
     "sort-packages": true
   },
-  "minimum-stability": "dev",
-  "prefer-stable": true
+  "config": {
+    "preferred-install": "dist"
+  },
+  "prefer-stable": true,
+  "scripts": {
+    "prod": "@production",
+    "production": ["@style", "@stan", "@test"],
+    "style": "./vendor/bin/phpcs --standard=phpcs.xml -p ./src",
+    "stan": "./vendor/bin/phpstan analyze",
+    "test": "./vendor/bin/phpunit"
+  }
 }