marked-katex-extension 1.0.0

package/.editorconfig

@@ -0,0 +1,16 @@
+root = true
+
+[*.{json,js}]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 2
+
+[*.md]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = tab
+indent_size = 4

package/.eslintignore

@@ -0,0 +1,2 @@
+lib
+*.min.js

package/.eslintrc.json

@@ -0,0 +1,26 @@
+{
+  "extends": "standard",
+  "rules": {
+    "semi": ["error", "always"],
+    "indent": ["error", 2, {
+      "SwitchCase": 1,
+      "VariableDeclarator": { "var": 2 },
+      "outerIIFEBody": 0
+    }],
+    "operator-linebreak": ["error", "before", { "overrides": { "=": "after" } }],
+    "space-before-function-paren": ["error", "never"],
+    "no-cond-assign": "off",
+    "no-useless-escape": "off",
+    "one-var": "off",
+    "no-control-regex": "off",
+    "no-prototype-builtins": "off",
+    "no-extra-semi": "error",
+
+    "prefer-const": "error",
+    "no-var": "error"
+  },
+  "env": {
+    "node": true,
+    "jest": true
+  }
+}

package/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+  - package-ecosystem: "npm"
+    versioning-strategy: "increase"
+    directory: "/"
+    schedule:
+      interval: "weekly"

package/.github/workflows/automerge.yml

@@ -0,0 +1,39 @@
+name: "Automerge"
+on:
+  workflow_run:
+    workflows:
+      - CI
+    types:
+      - completed
+
+jobs:
+  Automerge:
+    runs-on: ubuntu-latest
+    if: |
+      github.event.workflow_run.event == 'pull_request' &&
+      github.event.workflow_run.conclusion == 'success'
+    steps:
+      - name: 'Merge PR'
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          script: |
+            const pr = await github.rest.pulls.get({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              pull_number: context.payload.workflow_run.pull_requests[0].number,
+            });
+            if (!pr.data.title.startsWith('chore(deps-dev):')) {
+              console.log('Not Merged 🚫');
+              console.log(`Title '${pr.data.title}' does not start with 'chore(deps-dev):'`);
+            } else if (pr.data.user.login !== 'dependabot[bot]') {
+              console.log('Not Merged 🚫');
+              console.log(`User '${pr.data.user.login}' does not equal 'dependabot[bot]'`);
+            } else {
+              await github.rest.pulls.merge({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                pull_number: context.payload.workflow_run.pull_requests[0].number,
+              });
+              console.log('Merged 🎉');
+            }

package/.github/workflows/main.yml

@@ -0,0 +1,74 @@
+name: "CI"
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+
+  Test:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Install Node
+        uses: dcodeIO/setup-node-nvm@master
+        with:
+          node-version: node
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Tests 👩🏽‍💻
+        run: npm run test
+
+  Coverage:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Install Node
+        uses: dcodeIO/setup-node-nvm@master
+        with:
+          node-version: 'lts/*'
+      - name: Install Dependencies
+        run: npm ci
+      - name: Run Tests 👩🏽‍💻
+        run: npm run test:cover
+
+  Lint:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: npm ci
+      - name: Lint ✨
+        run: npm run lint
+
+  Release:
+    needs: [Test, Coverage, Lint]
+    if: |
+      github.ref == 'refs/heads/main' &&
+      github.event.repository.fork == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+      - name: Install Dependencies
+        run: npm ci
+      - name: Build 🗜️
+        run: |
+          npm run build
+          if ! git diff --quiet; then
+            git config --global user.email "<>"
+            git config --global user.name "CI Build"
+            git commit -am "🗜️ build [skip ci]"
+          fi
+      - name: Release 🎉
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 @markedjs
+
+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.

package/README.md

@@ -0,0 +1,40 @@
+# marked-katex-extension
+
+Render [katex](https://katex.org/) code in marked
+
+Note: Block level katex requires at least 2 `$` at the beginning and end.
+
+```markdown
+This is inline katex: $c = \\pm\\sqrt{a^2 + b^2}$
+
+This is block level katex:
+
+$$
+c = \\pm\\sqrt{a^2 + b^2}
+$$
+```
+
+# Usage
+
+```js
+const {marked} = require("marked");
+const markedKatex = require("marked-katex-extension");
+
+// or ES Module script
+// import marked from "https://cdn.jsdelivr.net/gh/markedjs/marked/lib/marked.esm.js";
+// import markedKatex from "https://cdn.jsdelivr.net/gh/UziTech/marked-katex-extension/lib/index.mjs";
+
+const options = {
+  throwOnError: false
+};
+
+marked.use(markedKatex(options));
+
+marked("katex: $c = \\pm\\sqrt{a^2 + b^2}$");
+```
+
+![image](https://user-images.githubusercontent.com/97994/188899567-e6e8268c-209e-4067-8f44-0ada16caacdd.png)
+
+## `options`
+
+Options are sent directly to [`katex.renderToString`](https://katex.org/docs/api.html#server-side-rendering-or-rendering-to-a-string)

package/babel.config.json

@@ -0,0 +1,3 @@
+{
+  "presets": ["@babel/preset-env"]
+}

package/jest.config.js

@@ -0,0 +1,21 @@
+export default {
+  restoreMocks: true,
+  clearMocks: true,
+  // collectCoverage: true,
+  collectCoverageFrom: [
+    'src/index.js'
+  ],
+  coverageDirectory: 'coverage',
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100
+    }
+  },
+  testRegex: /\.test\.js$/.source,
+  transform: {
+    '\\.[jt]sx?$': 'babel-jest'
+  }
+};