Deprecate markdown-toolbar-element

.github/dependabot.yml

@@ -0,0 +1,51 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:00"
+  open-pull-requests-limit: 0
+  ignore:
+  - dependency-name: eslint
+    versions:
+    - 7.18.0
+    - 7.19.0
+    - 7.20.0
+    - 7.21.0
+    - 7.23.0
+    - 7.24.0
+  - dependency-name: karma
+    versions:
+    - 6.0.3
+    - 6.0.4
+    - 6.1.0
+    - 6.1.1
+    - 6.1.2
+    - 6.3.0
+    - 6.3.1
+  - dependency-name: mocha
+    versions:
+    - 8.2.1
+    - 8.3.0
+    - 8.3.1
+  - dependency-name: chai
+    versions:
+    - 4.3.0
+    - 4.3.1
+    - 4.3.3
+  - dependency-name: socket.io
+    versions:
+    - 2.4.1
+  - dependency-name: dot-prop
+    versions:
+    - 4.2.1
+  - dependency-name: npm-watch
+    versions:
+    - 0.7.0
+  - dependency-name: lodash
+    versions:
+    - 4.17.20
+  - dependency-name: eslint-plugin-github
+    versions:
+    - 4.1.1

.github/workflows/ci.yml

@@ -0,0 +1,61 @@
+on: [push, pull_request]
+jobs:
+  codeql-sast:
+    name: CodeQL SAST scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/codeql-analysis.yml@main
+    permissions:
+      security-events: write
+
+  dependency-review:
+    name: Dependency Review scan
+    uses: alphagov/govuk-infrastructure/.github/workflows/dependency-review.yml@main
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: lts/*
+          cache: npm
+      - run: npm ci
+      - run: npm run test
+      - run: npm run build
+
+  release:
+    needs: test
+    runs-on: ubuntu-latest
+    if: ${{ github.ref == 'refs/heads/main' }}
+    permissions:
+      contents: write 
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v2
+        with:
+          node-version: lts/*
+          cache: npm
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+      - run: npm run build
+      - name: Deploy to GitHub Pages
+        uses: JamesIves/github-pages-deploy-action@0f24da7de3e7e135102609a4c9633b025be8411b
+        with:
+          branch: gh-pages
+          folder: examples
+      - name: Establish version
+        run: |
+          LOCAL=$(node -p "require('./package.json').version")
+          echo "::set-output name=local::${LOCAL}"
+          echo "::set-output name=remote::$(npm view markdown-toolbar-element version)"
+          if git ls-remote --tags --exit-code origin ${LOCAL}; then
+            echo "::set-output name=tagged::yes"
+          fi
+        id: version
+      - name: Tag version
+        if: ${{ steps.version.outputs.tagged != 'yes' }}
+        run: git tag ${{ steps.version.outputs.local }} && git push --tags
+      - name: Release to NPM
+        if: ${{ steps.version.outputs.local != steps.version.outputs.remote }}
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.ALPHAGOV_NPM_AUTOMATION_TOKEN }}

.gitignore

@@ -1,2 +1,2 @@
-dist
 node_modules
+examples/dist

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+
+- We use [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+- Mark breaking changes with `BREAKING:`. Be sure to include instructions on
+  how applications should be upgraded.
+- Include a link to your pull request.
+- Don't include changes that are purely internal. The CHANGELOG should be a
+  useful summary for people upgrading their application, not a replication
+  of the commit log.
+
+## 0.2.0
+
+- Update link button to render email markdown (PR #8)
+- Expose `insertText` and `newlinesToSurroundSelectedText` as public (PR #4)
+- Fix ordered and unordered list injector (PR #3)
+- Remove `contenteditable` attribute as it blocks users from editing the textarea after injecting markdown on IE11 (PR #2)
+- Add the following govpseak injectors: H2, H3, H4, CTA (call to action), email and address (PR #1)
+
+## 0.1.0
+
+- Initial release forked from [github/markdown-toolbar-element](https://github.com/github/markdown-toolbar-element/releases/tag/v0.1.0)

LICENSE

@@ -1,11 +1,13 @@
-Copyright (c) 2017-2018 GitHub, Inc.
+The MIT License (MIT)
 
-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:
+Copyright (C) 2017 Crown Copyright (Government Digital Service)
+
+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.

README.md

@@ -1,32 +1,27 @@
-# <markdown-toolbar> element
+# <markdown-toolbar> element (DEPRECATED)
+
+> **NOTE**: This project is deprecated and is [planned to be retired](https://trello.com/c/v6AT6hNR/88-remove-markdown-toolbar-element-from-content-publisher).
+
+---
 
 Markdown formatting buttons for text inputs.
 
 ## Installation
 
 ```
-$ npm install --save @github/markdown-toolbar-element
+npm install --save markdown-toolbar-element
 ```
 
 ## Usage
 
-```js
-import '@github/markdown-toolbar-element'
-```
-
 ```html
 <markdown-toolbar for="textarea_id">
-  <md-bold>bold</md-bold>
-  <md-header>header</md-header>
-  <md-italic>italic</md-italic>
-  <md-quote>quote</md-quote>
-  <md-code>code</md-code>
+  <md-header-2>heading 2</md-header-2>
+  <md-header-3>heading 3</md-header-3>
   <md-link>link</md-link>
-  <md-unordered-list>unordered-list</md-unordered-list>
+  <md-quote>quote</md-quote>
   <md-ordered-list>ordered-list</md-ordered-list>
-  <md-task-list>task-list</md-task-list>
-  <md-mention>mention</md-mention>
-  <md-ref>ref</md-ref>
+  <md-unordered-list>unordered-list</md-unordered-list>
 </markdown-toolbar>
 <textarea id="textarea_id"></textarea>
 ```