Ensure screen readers announce text copying (#66)

Author: jperasmus

.eslintrc.js

@@ -1,41 +1,40 @@
 module.exports = {
-    "env": {
-        "browser" : true,
-        "commonjs": true,
-        "es6"     : true,
-        "node"    : true
-    },
-    "extends": "eslint:recommended",
-    "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType" : "module"
-    },
-    "plugins": [
-    ],
-    "rules": {
-        "array-bracket-spacing"      : ["error", "never"],
-        "array-callback-return"      : ["error"],
-        "block-scoped-var"           : ["error"],
-        "block-spacing"              : ["error", "always"],
-        "curly"                      : ["error"],
-        "dot-notation"               : ["error"],
-        "eqeqeq"                     : ["error"],
-        "indent"                     : ["error", 4],
-        "linebreak-style"            : ["error", "unix"],
-        "no-console"                 : ["warn"],
-        "no-floating-decimal"        : ["error"],
-        "no-implicit-coercion"       : ["error"],
-        "no-implicit-globals"        : ["error"],
-        "no-loop-func"               : ["error"],
-        "no-return-assign"           : ["error"],
-        "no-template-curly-in-string": ["error"],
-        "no-unneeded-ternary"        : ["error"],
-        "no-unused-vars"             : ["error", { "args": "none" }],
-        "no-useless-computed-key"    : ["error"],
-        "no-useless-return"          : ["error"],
-        "no-var"                     : ["error"],
-        "prefer-const"               : ["error"],
-        "quotes"                     : ["error", "single"],
-        "semi"                       : ["error", "always"]
-    }
+  env: {
+    browser: true,
+    commonjs: true,
+    es6: true,
+    node: true,
+  },
+  extends: ['eslint:recommended', 'prettier'],
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module',
+  },
+  plugins: [],
+  rules: {
+    'array-bracket-spacing': ['error', 'never'],
+    'array-callback-return': ['error'],
+    'block-scoped-var': ['error'],
+    'block-spacing': ['error', 'always'],
+    curly: ['error'],
+    'dot-notation': ['error'],
+    eqeqeq: ['error'],
+    indent: ['error', 2],
+    'linebreak-style': ['error', 'unix'],
+    'no-console': ['warn'],
+    'no-floating-decimal': ['error'],
+    'no-implicit-coercion': ['error'],
+    'no-implicit-globals': ['error'],
+    'no-loop-func': ['error'],
+    'no-return-assign': ['error'],
+    'no-template-curly-in-string': ['error'],
+    'no-unneeded-ternary': ['error'],
+    'no-unused-vars': ['error', { args: 'none' }],
+    'no-useless-computed-key': ['error'],
+    'no-useless-return': ['error'],
+    'no-var': ['error'],
+    'prefer-const': ['error'],
+    quotes: ['error', 'single'],
+    semi: ['error', 'always'],
+  },
 };

.gitignore

@@ -8,6 +8,10 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 
+# OS files
+.DS_Store
+Thumbs.db
+
 # Runtime data
 pids
 *.pid

.nvmrc

@@ -0,0 +1 @@
+18

.prettierignore

@@ -0,0 +1,3 @@
+# Ignore artifacts
+dist
+node_modules

.prettierrc.json

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

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["docsify", "iife"]
+}

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 2.1.0
 
-*2019-01-23*
+_2019-01-23_
 
 - Added localization (l10n) support via `copyCode` options
 - Added error feedback (UI & console)
@@ -13,14 +13,14 @@
 
 ## 2.0.2
 
-*2018-04-16*
+_2018-04-16_
 
 - Updated plugin bundling configuration
 - Removed necessity for `init()` method
 - Removed external stylesheet
 
 ## 1.0.0
 
-*2017-09-28*
+_2017-09-28_
 
 - Initial release

README.md

@@ -24,6 +24,7 @@ If you prefer to load the latest version of the library, you may do so by omitti
 <!-- Latest (not recommended for production) -->
 <script src="https://unpkg.com/docsify-copy-code"></script>
 ```
+
 ## Usage
 
 Create a markdown code block with help of triple backticks at the beginning and end of your code. This block will have a copy button on the top right when hovering over it.
@@ -38,11 +39,11 @@ Button text can be customized as follows:
 window.$docsify = {
   // docsify-copy-code (defaults)
   copyCode: {
-    buttonText : 'Copy to clipboard',
-    errorText  : 'Error',
-    successText: 'Copied'
-  }
-}
+    buttonText: 'Copy to clipboard',
+    errorText: 'Error',
+    successText: 'Copied',
+  },
+};
 ```
 
 ### Localization (l10n)
@@ -54,25 +55,25 @@ window.$docsify = {
   copyCode: {
     buttonText: {
       '/zh-cn/': '点击复制',
-      '/ru/'   : 'Скопировать в буфер обмена',
+      '/ru/': 'Скопировать в буфер обмена',
       '/de-de/': 'Klicken Sie zum Kopieren',
-      '/es/'   : 'Haga clic para copiar',
-      '/'      : 'Copy to clipboard'
+      '/es/': 'Haga clic para copiar',
+      '/': 'Copy to clipboard',
     },
     errorText: {
       '/zh-cn/': '错误',
-      '/ru/'   : 'ошибка',
-      '/'      : 'Error'
+      '/ru/': 'ошибка',
+      '/': 'Error',
     },
     successText: {
       '/zh-cn/': '复制',
-      '/ru/'   : 'Скопировано',
+      '/ru/': 'Скопировано',
       '/de-de/': 'Kopiert',
-      '/es/'   : 'Copiado',
-      '/'      : 'Copied'
-    }
-  }
-}
+      '/es/': 'Copiado',
+      '/': 'Copied',
+    },
+  },
+};
 ```
 
 **Note:** Docsify's [alias](https://docsify.js.org/#/configuration?id=alias) option makes it easy to manage local content using separate directories. See the [`/demo/`](https://github.com/jperasmus/docsify-copy-code/tree/master/demo) content in this repo for an example.

demo/index.html

@@ -1,20 +1,22 @@
 <!DOCTYPE html>
 <html>
+
 <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <link rel="stylesheet" href="https://unpkg.com/docsify/themes/vue.css">
     <!-- <link rel="stylesheet" href="https://unpkg.com/docsify-themeable/dist/css/theme-simple.css"> -->
 </head>
+
 <body>
     <div id="app"></div>
     <script>
         window.$docsify = {
             // GENERAL
             // -----------------------------------------------------------------
-            name      : 'docsify-copy-code',
-            repo      : 'https://github.com/jperasmus/docsify-copy-code',
+            name: 'docsify-copy-code',
+            repo: 'https://github.com/jperasmus/docsify-copy-code',
             loadNavbar: 'navbar.md',
             // themeColor: 'purple',
 
@@ -26,8 +28,8 @@
                 // Locals
                 '/zh-cn/(.*)': './zh-cn/$1',
                 '/de-de/(.*)': './de-de/$1',
-                '/ru/(.*)'   : './ru/$1',
-                '/es/(.*)'   : './es/$1'
+                '/ru/(.*)': './ru/$1',
+                '/es/(.*)': './es/$1'
             },
 
             // PLUGINS
@@ -39,27 +41,28 @@
 
                 buttonText: {
                     '/zh-cn/': '点击复制',
-                    '/ru/'   : 'Скопировать в буфер обмена',
+                    '/ru/': 'Скопировать в буфер обмена',
                     '/de-de/': 'Klicken Sie zum Kopieren',
-                    '/es/'   : 'Haga clic para copiar',
-                    '/'      : 'Copy to clipboard'
+                    '/es/': 'Haga clic para copiar',
+                    '/': 'Copy to clipboard'
                 },
                 errorText: {
                     '/zh-cn/': '错误',
-                    '/ru/'   : 'ошибка',
-                    '/'      : 'Error'
+                    '/ru/': 'ошибка',
+                    '/': 'Error'
                 },
                 successText: {
                     '/zh-cn/': '复制',
-                    '/ru/'   : 'Скопировано',
+                    '/ru/': 'Скопировано',
                     '/de-de/': 'Kopiert',
-                    '/es/'   : 'Copiado',
-                    '/'      : 'Copied'
+                    '/es/': 'Copiado',
+                    '/': 'Copied'
                 }
             }
         }
     </script>
     <script src="https://unpkg.com/docsify@4"></script>
     <script src="/dist/docsify-copy-code.js"></script>
 </body>
+
 </html>

index.js

@@ -1,14 +1,16 @@
 // Fix for v1.x installations
-(function() {
-    // Deprecation warning for v1.x: init()
-    window.DocsifyCopyCodePlugin = {
-        init: function() {
-            return function(hook, vm) {
-                hook.ready(function() {
-                    // eslint-disable-next-line
-                    console.warn('[Update] docsify-copy-code has been updated. Please see new installation instructions at https://github.com/jperasmus/docsify-copy-code.');
-                });
-            };
-        }
-    };
+(function () {
+  // Deprecation warning for v1.x: init()
+  window.DocsifyCopyCodePlugin = {
+    init: function () {
+      return function (hook, vm) {
+        hook.ready(function () {
+          // eslint-disable-next-line no-console
+          console.warn(
+            '[Update] docsify-copy-code has been updated. Please see new installation instructions at https://github.com/jperasmus/docsify-copy-code.'
+          );
+        });
+      };
+    },
+  };
 })();