chore: minor repo maintenance

Author: erunion

.babelrc

@@ -1,10 +1,13 @@
 {
   "presets": [
-    ["@babel/preset-env", {
-      "targets": {
-        "browsers": ["last 2 versions"]
+    [
+      "@babel/preset-env",
+      {
+        "targets": {
+          "browsers": ["last 2 versions"]
+        }
       }
-    }],
+    ],
     "@babel/preset-react"
   ]
 }

.eslintrc

@@ -1,7 +1,4 @@
 {
-  "extends": [
-    "@readme/eslint-config",
-    "@readme/eslint-config/react"
-  ],
+  "extends": ["@readme/eslint-config", "@readme/eslint-config/react"],
   "root": true
 }

.github/CONTRIBUTING.md

@@ -10,10 +10,10 @@ For our general commit conventions please consult our organization contributing
 
 To add a new language:
 
-* Create a new directory in the fixtures directory for the language (for example): `__tests__/__fixtures__/js/`
-* Add a `sample.js` file into `__tests__/__fixtures__/js/` containing a code snippet of the language you're targeting
-    * https://github.com/leachim6/hello-world/ is a helpful resource covering most every language
-* Add a `index.js` file in `__tests__/__fixtures__/js/` that matches the following structure:
+- Create a new directory in the fixtures directory for the language (for example): `__tests__/__fixtures__/js/`
+- Add a `sample.js` file into `__tests__/__fixtures__/js/` containing a code snippet of the language you're targeting
+  - https://github.com/leachim6/hello-world/ is a helpful resource covering most every language
+- Add a `index.js` file in `__tests__/__fixtures__/js/` that matches the following structure:
 
 ```js
 module.exports = {
@@ -31,13 +31,13 @@ module.exports = {
     aliases: {
       // Any additional extension modes that this language might utilize or be known under (SQL
       // variants for example). Consult the CodeMirror meta file for this list.
-      languageModeAlias: 'Language Name'
+      languageModeAlias: 'Language Name',
     },
   },
 };
 ```
 
-* Update `canonical.js` and add any mode aliases you've added into your test, mapping them back to the canonical version
-  * `yml` → `yaml`, `ts` → `typescript`, etc.
-* Update `uppercase.js` for any new language names, or aliases, you've added.
-* Lastly, make sure that the README is updated! 🚀
+- Update `canonical.js` and add any mode aliases you've added into your test, mapping them back to the canonical version
+  - `yml` → `yaml`, `ts` → `typescript`, etc.
+- Update `uppercase.js` for any new language names, or aliases, you've added.
+- Lastly, make sure that the README is updated! 🚀

.github/dependabot.yml

@@ -1,7 +1,7 @@
 version: 2
 updates:
   - package-ecosystem: github-actions
-    directory: "/"
+    directory: '/'
     schedule:
       interval: monthly
     reviewers:
@@ -13,7 +13,7 @@ updates:
       prefix-development: chore(deps-dev)
 
   - package-ecosystem: npm
-    directory: "/"
+    directory: '/'
     schedule:
       interval: monthly
     open-pull-requests-limit: 10

.github/workflows/codeql-analysis.yml

@@ -1,10 +1,10 @@
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
-    branches: [ main ]
+    branches: [main]
   schedule:
     - cron: '0 0 1 * *'
 
@@ -20,16 +20,16 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v4
+      - name: Checkout repository
+        uses: actions/checkout@v4
 
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
-      with:
-        languages: ${{ matrix.language }}
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
 
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3

.npmignore

@@ -1,6 +1,5 @@
 __tests__/
 .github/
-.husky/
 coverage/
 .eslint*
 .prettier*

.prettierignore

@@ -2,3 +2,5 @@ __tests__/__fixtures__/
 __tests__/__snapshots__/
 coverage/
 dist/
+*.html
+*.scss

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2020, ReadMe
+Copyright (c) 2024, ReadMe
 
 Permission to use, copy, modify, and/or distribute this software for any purpose
 with or without fee is hereby granted, provided that the above copyright notice

README.md

@@ -13,19 +13,23 @@ npm install --save @readme/syntax-highlighter
 ```
 
 ## Usage
+
 ### Read Only Mode
+
 ```js
 const syntaxHighlighter = require('@readme/syntax-highlighter');
 const ele = syntaxHighlighter('console.log("Hello, world!");', 'js');
 ```
 
 ### Read Only with Line Numbers
+
 ```js
 const syntaxHighlighter = require('@readme/syntax-highlighter');
 const ele = syntaxHighlighter('console.log("Hello, world!");', 'js', { ...opts, highlightMode: true });
 ```
 
 ### Read Only with Line Numbers and Highlighted Ranges
+
 ```js
 const syntaxHighlighter = require('@readme/syntax-highlighter');
 const ele = syntaxHighlighter('console.log("Hello, world!");', 'js', {
@@ -41,19 +45,17 @@ const ele = syntaxHighlighter('console.log("Hello, world!");', 'js', {
 ```
 
 ### Full CodeMirror
+
 Access to a full code Mirror instance. See configuration settings in the [`react-codemirror2` library][react-codemirror#props]
 
 ```js
 const syntaxHighlighter = require('@readme/syntax-highlighter');
-const ele = syntaxHighlighter(
-  'console.log("Hello, world!");',
-  'js',
-  { ...opts, editable: true },
-  { ...editorProps }
-);
+const ele = syntaxHighlighter('console.log("Hello, world!");', 'js', { ...opts, editable: true }, { ...editorProps });
 ```
 
 ### Available Options
+
+<!-- prettier-ignore-start -->
 | Name | Type | Description |
 | :--- | :--- | :--- |
 | `customTheme` | String | Highlighting theme. One of `neo`, `material-palenight`, or `tomorrow-night`. (Setting this will override the `dark` mode option.)
@@ -63,9 +65,11 @@ const ele = syntaxHighlighter(
 | `inline` | String | Wrap code in a `<span>` tag, instead of a `<div>`. |
 | `ranges` | Array | Ranges of line numbers to apply highlighting to. Requires `highlightMode` enabled |
 | `tokenizeVariables` | Boolean | Match and render [ReadMe variables](rdme-variable) in your markdown. |
+<!-- prettier-ignore-end -->
 
 ## Languages Supported
 
+<!-- prettier-ignore-start -->
 | Language | Available language mode(s) |
 | :--- | :--- |
 | ASP.NET | `asp`, `aspx` |
@@ -110,7 +114,7 @@ const ele = syntaxHighlighter(
 | TOML | `toml` |
 | TypeScript | `ts`, `typescript` |
 | YAML | `yaml`, `yml` |
-
+<!-- prettier-ignore-end -->
 
 [rdme-variable]: https://github.com/readmeio/api-explorer/tree/next/packages/variable
 [codemirror]: https://github.com/codemirror/CodeMirror