inject format func with jinja

Author: chrisjsewell

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+max-line-length = 88
+ignore=E203,W503

.github/workflows/integration.yml

@@ -4,6 +4,24 @@ on: [push, pull_request]
 
 jobs:
 
+  pre-commit:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[code_style]
+    - name: Run pre-commit
+      run: |
+        pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
+
   docs:
 
     runs-on: ubuntu-latest
@@ -32,7 +50,7 @@ jobs:
   publish:
 
     name: Publish to PyPi
-    needs: [docs]
+    needs: [pre-commit, docs]
     if: github.event_name == 'push' && startsWith(github.event.ref, 'refs/tags')
     runs-on: ubuntu-latest
     steps:

.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+# Install pre-commit hooks via
+# pre-commit install
+
+exclude: >
+    (?x)^(
+      \.vscode/settings\.json
+    )$
+
+repos:
+
+  - repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: v2.2.3
+    hooks:
+    - id: check-json
+    - id: check-yaml
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+    - id: flake8
+
+  - repo: https://github.com/psf/black
+    rev: stable
+    hooks:
+    - id: black

doc/Makefile

@@ -17,4 +17,4 @@ help:
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
-	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

doc/conf.py

@@ -19,14 +19,14 @@
 
 # -- Project information -----------------------------------------------------
 
-project = 'Sphinx Copybutton'
-copyright = '2018, Chris Holdgraf'
-author = 'Chris Holdgraf'
+project = "Sphinx Copybutton"
+copyright = "2018, Chris Holdgraf"
+author = "Chris Holdgraf"
 
 # The short X.Y version
-version = ''
+version = ""
 # The full version, including alpha/beta/rc tags
-release = ''
+release = ""
 
 
 # -- General configuration ---------------------------------------------------
@@ -38,19 +38,19 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx_copybutton']
+extensions = ["sphinx_copybutton"]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -62,18 +62,18 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path .
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = "alabaster"
 # html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -85,7 +85,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -109,7 +109,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SphinxCopybuttondoc'
+htmlhelp_basename = "SphinxCopybuttondoc"
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -118,15 +118,12 @@
     # The paper size ('letterpaper' or 'a4paper').
     #
     # 'papersize': 'letterpaper',
-
     # The font size ('10pt', '11pt' or '12pt').
     #
     # 'pointsize': '10pt',
-
     # Additional stuff for the LaTeX preamble.
     #
     # 'preamble': '',
-
     # Latex figure (float) alignment
     #
     # 'figure_align': 'htbp',
@@ -136,8 +133,13 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'SphinxCopybutton.tex', 'Sphinx Copybutton Documentation',
-     'Chris Holdgraf', 'manual'),
+    (
+        master_doc,
+        "SphinxCopybutton.tex",
+        "Sphinx Copybutton Documentation",
+        "Chris Holdgraf",
+        "manual",
+    )
 ]
 
 
@@ -146,8 +148,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'sphinxcopybutton', 'Sphinx Copybutton Documentation',
-     [author], 1)
+    (master_doc, "sphinxcopybutton", "Sphinx Copybutton Documentation", [author], 1)
 ]
 
 
@@ -157,7 +158,13 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'SphinxCopybutton', 'Sphinx Copybutton Documentation',
-     author, 'SphinxCopybutton', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "SphinxCopybutton",
+        "Sphinx Copybutton Documentation",
+        author,
+        "SphinxCopybutton",
+        "One line description of project.",
+        "Miscellaneous",
+    )
 ]

doc/requirements.txt

@@ -1,4 +1,4 @@
 sphinx
 
 # Install ourselves
-.
+.

setup.py

@@ -3,19 +3,22 @@
 
 from setuptools import setup, find_packages
 
-if (os.path.isdir('clipboard.js') and
-        not os.path.islink('sphinx_copybutton/_static/clipboard.min.js')):
+if os.path.isdir("clipboard.js") and not os.path.islink(
+    "sphinx_copybutton/_static/clipboard.min.js"
+):
     raise SystemExit("Error: Support for symbolic links is required")
 
-if (os.path.isdir('clipboard.js') and
-        not os.path.isfile('clipboard.js/dist/clipboard.min.js')):
+if os.path.isdir("clipboard.js") and not os.path.isfile(
+    "clipboard.js/dist/clipboard.min.js"
+):
     raise SystemExit(
         """Error: clipboard.js submodule not available, run
 
         git submodule update --init
-        """)
+        """
+    )
 
-with open('./README.md', 'r') as ff:
+with open("./README.md", "r") as ff:
     readme_text = ff.read()
 
 # Parse version
@@ -26,21 +29,27 @@
 version = line.split(" = ")[-1].strip('"')
 
 setup(
-    name='sphinx-copybutton',
+    name="sphinx-copybutton",
     version=version,
     description="Add a copy button to each of your code cells.",
     long_description=readme_text,
-    long_description_content_type='text/markdown',
-    author='Executable Book Project',
+    long_description_content_type="text/markdown",
+    author="Executable Book Project",
     url="https://github.com/ExecutableBookProject/sphinx-copybutton",
-    license='MIT License',
+    license="MIT License",
     packages=find_packages(),
-    package_data={'sphinx_copybutton': ['_static/copybutton.css',
-                                        '_static/copybutton.js_t',
-                                        '_static/copy-button.svg',
-                                        '_static/clipboard.min.js']},
+    package_data={
+        "sphinx_copybutton": [
+            "_static/copybutton.css",
+            "_static/copybutton_funcs.js",
+            "_static/copybutton.js_t",
+            "_static/copy-button.svg",
+            "_static/clipboard.min.js",
+        ]
+    },
     classifiers=["License :: OSI Approved :: MIT License"],
-    install_requires=[
-        "sphinx>=1.8"
-    ]
+    install_requires=["sphinx>=1.8"],
+    extras_require={
+        "code_style": ["flake8<3.8.0,>=3.7.0", "black", "pre-commit==1.17.0"],
+    },
 )

sphinx_copybutton/__init__.py

@@ -1,27 +1,44 @@
 """A small sphinx extension to add "copy" buttons to code blocks."""
-import os
+from pathlib import Path
 from sphinx.util import logging
 
 __version__ = "0.2.12dev0"
 
 logger = logging.getLogger(__name__)
 
+
 def scb_static_path(app):
-    static_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '_static'))
-    app.config.html_static_path.append(static_path)
+    app.config.html_static_path.append(
+        str(Path(__file__).parent.joinpath("_static").absolute())
+    )
+
 
 def add_to_context(app, config):
     # Update the global context
-    config.html_context.update({'copybutton_prompt_text': config.copybutton_prompt_text})
-    config.html_context.update({'copybutton_only_copy_prompt_lines': config.copybutton_only_copy_prompt_lines})
-    config.html_context.update({'copybutton_remove_prompts': config.copybutton_remove_prompts})
-    config.html_context.update({'copybutton_image_path': config.copybutton_image_path})
-    config.html_context.update({'copybutton_selector': config.copybutton_selector})
+    config.html_context.update(
+        {"copybutton_prompt_text": config.copybutton_prompt_text}
+    )
+    config.html_context.update(
+        {"copybutton_only_copy_prompt_lines": config.copybutton_only_copy_prompt_lines}
+    )
+    config.html_context.update(
+        {"copybutton_remove_prompts": config.copybutton_remove_prompts}
+    )
+    config.html_context.update({"copybutton_image_path": config.copybutton_image_path})
+    config.html_context.update({"copybutton_selector": config.copybutton_selector})
+    config.html_context.update(
+        {
+            "copybutton_format_func": Path(__file__)
+            .parent.joinpath("_static", "copybutton_funcs.js")
+            .read_text()
+        }
+    )
+
 
 def setup(app):
-    logger.verbose('Adding copy buttons to code blocks...')
+    logger.verbose("Adding copy buttons to code blocks...")
     # Add our static path
-    app.connect('builder-inited', scb_static_path)
+    app.connect("builder-inited", scb_static_path)
 
     # configuration for this tool
     app.add_config_value("copybutton_prompt_text", "", "html")
@@ -34,9 +51,11 @@ def setup(app):
     app.connect("config-inited", add_to_context)
 
     # Add relevant code to headers
-    app.add_css_file('copybutton.css')
-    app.add_js_file('clipboard.min.js')
+    app.add_css_file("copybutton.css")
+    app.add_js_file("clipboard.min.js")
     app.add_js_file("copybutton.js")
-    return {"version": __version__,
-            "parallel_read_safe": True,
-            "parallel_write_safe": True}
+    return {
+        "version": __version__,
+        "parallel_read_safe": True,
+        "parallel_write_safe": True,
+    }

sphinx_copybutton/_static/copy-button.svg

@@ -1,5 +1,3 @@
-import { formatCopyText } from "./copybutton_funcs";
-
 // Localization support
 const messages = {
   'en': {
@@ -84,6 +82,8 @@ const addCopyButtonToCodeCells = () => {
     codeCell.insertAdjacentHTML('afterend', clipboardButton(id))
   })
 
+{{ copybutton_format_func }}
+
 var copyTargetText = (target) => {
   var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
   var textContent = target.innerText.split('\n');

sphinx_copybutton/_static/copybutton.js_t

@@ -30,4 +30,4 @@ export function formatCopyText(textContent, copybuttonPromptText, onlyCopyPrompt
         textContent = textContent.slice(0, -1)
     }
     return textContent
-}
+}