first commit

.eslintignore

@@ -0,0 +1,2 @@
+dist/
+coverage/

.eslintrc.json

@@ -0,0 +1,18 @@
+{
+  "env": {
+    "es2021": true,
+    "node": true
+  },
+  "globals": {
+    "jest": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:node/recommended",
+    "plugin:jest/recommended"
+  ],
+  "parserOptions": {
+    "ecmaVersion": 12,
+    "sourceType": "module"
+  }
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: monthly
+  - package-ecosystem: github-actions
+    directory: '/'
+    schedule:
+      interval: monthly

.github/workflows/publish.yml

@@ -0,0 +1,17 @@
+name: Publish
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  test:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm ci
+      - run: npm test
+      - run: npx semantic-release

.github/workflows/seocheck.yml

@@ -0,0 +1,20 @@
+name: Integraton Test
+
+on: [pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          version: 12
+      - name: Markdown SEO Check
+        uses: ./
+        with:
+          max_title_length: 70
+          max_description_length: 150
+          max_slug_length: 100
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - '**'
+      - '!main'
+
+jobs:
+  test:
+    env:
+      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - run: npm ci
+      - name: Lint Code Base
+        uses: github/[email protected]
+        env:
+          LINTER_RULES_PATH: /
+          FILTER_REGEX_EXCLUDE: (.*dist\/.*)|(.husky\/.*)
+          JAVASCRIPT_ES_CONFIG_FILE: .eslintrc.json
+          VALIDATE_ALL_CODEBASE: true
+          VALIDATE_JAVASCRIPT_STANDARD: false
+          DEFAULT_BRANCH: main
+      # - run: npm test

.gitignore

@@ -0,0 +1,37 @@
+node_modules/
+
+# Editors
+.vscode/
+.idea/
+*.iml
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no-install commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "singleQuote": true,
+  "semi": false,
+  "trailingComma": "none"
+}

CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# How to contribute
+
+We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
+
+## Code reviews
+
+All submissions require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
+
+## Style Guide
+
+This project provides a prettier configuration. All submitted PRs will be required to conform to this style guide before being merged.

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Zentered OÜ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,54 @@
+<p align="center">
+  <img src="res/markdowncheck.png">
+</p>
+
+<p align="center">
+  <a href="https://github.com/zentered/markdown-seo-check/actions/workflows/seocheck.yml"><img alt="Workflow Integration Test status" src="https://github.com/zentered/markdown-seo-check/actions/workflows/seocheck.yml/badge.svg"></a>
+  <a href="https://github.com/zentered/markdown-seo-check/actions/workflows/test.yml"><img alt="Unit Test status" src="https://github.com/zentered/markdown-seo-check/actions/workflows/test.yml/badge.svg"></a>
+  <a href="https://github.com/zentered/markdown-seo-check/actions/workflows/publish.yml"><img alt="Unit Test status" src="https://github.com/zentered/markdown-seo-check/actions/workflows/publish.yml/badge.svg"></a>
+  <a href="https://semantic-release.gitbook.io/semantic-release/"><img alt="Semantic Release bagde" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg"></a>
+  <a href="https://zentered.co"><img alt="Semantic Release bagde" src="https://img.shields.io/badge/>-Zentered-lightgrey?style=flat"></a>
+</p>
+
+# Markdown SEO Check
+
+Validate markdown files with SEO best practices. Creates a pull request comment and fails if conditions are not met.
+
+## Table of Contents
+
+- [Usage](#usage)
+- [Inputs](#inputs)
+- [Outputs](#outputs)
+
+## Usage
+
+```yaml
+- name: Markdown SEO Check
+  uses: zentered/[email protected]
+  with:
+    max_title_length: 70
+    max_description_length: 150
+    max_slug_length: 100
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Inputs
+
+| Name                     | Requirement | Default | Description                   |
+| ------------------------ | ----------- | ------- | ----------------------------- |
+| `max_title_length`       | required    | 70      | Maximum length of page title  |
+| `max_description_length` | required    | 150     | Maximum length of description |
+| `max_slug_length`        | required    | 100     | Maximum length of slug        |
+
+## Outputs
+
+![screenshot of github comment](res/output.png)
+
+## Contributing
+
+See [CONTRIBUTING](CONTRIBUTING.md).
+
+## License
+
+See [LICENSE](LICENSE).

action.yml

@@ -0,0 +1,21 @@
+branding:
+  color: green
+  icon: check-square
+description: 'Check markdown files '
+inputs:
+  max_title_length:
+    description: 'Maximum length for page title'
+    required: true
+    default: 70
+  max_description_length:
+    description: 'Maximum length for description'
+    required: true
+    default: 150
+  max_slug_length:
+    description: 'Maximum length for slug'
+    required: true
+    default: 100
+name: Markdown SEO Check
+runs:
+  main: dist/index.js
+  using: node12

babel.config.json

@@ -0,0 +1,12 @@
+{
+  "presets": [
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "node": true
+        }
+      }
+    ]
+  ]
+}