Initial release to wrap table in markdown-it

Author: samiahmedsiddiqui

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+quote_type = single
+trim_trailing_whitespace = true
+insert_final_newline = true

.eslintrc

@@ -0,0 +1,34 @@
+{
+  "root": true,
+  "env": {
+    "es6": true,
+    "node": true,
+    "mocha": true
+  },
+  "extends": [
+    "eslint:recommended"
+  ],
+  "overrides": [
+    {
+      "files": [
+        "*.ts",
+        "*.tsx"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "plugins": [
+        "@typescript-eslint"
+      ],
+      "extends": [
+        "plugin:@typescript-eslint/recommended"
+      ]
+    }
+  ],
+  "rules": {
+    "@typescript-eslint/ban-ts-comment": [
+      "error",
+      {
+        "ts-ignore": "allow-with-description"
+      }
+    ]
+  }
+}

.gitattributes

@@ -0,0 +1,17 @@
+# Set the default behavior, in case people don't have `core.autocrlf` set.
+* text=auto
+
+# Declare files that will always have LF line endings on checkout.
+*.ts text eol=lf
+
+# Remove files for archives generated using `git archive`.
+.*                     export-ignore
+appveyor.yml           export-ignore
+fixup                  export-ignore
+package-lock.json      export-ignore
+src                    export-ignore
+test                   export-ignore
+tsconfig.json          export-ignore
+tsconfig-cjs.json      export-ignore
+tsconfig-esm.json      export-ignore
+types/                 export-ignore

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+node_modules
+npm-debug.log
+yarn-error.log

CHANGELOG.md

@@ -0,0 +1,5 @@
+# markdown-it-table-wrap changelog
+
+## 1.0.0 - May 03, 2024
+
+- Initial Release

LICENSE

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

README.md

@@ -0,0 +1,47 @@
+# markdown-it-table-wrap
+
+[![NPM version][npm-image]][npm-url]
+[![Downloads][downloads-image]][npm-url]
+[![AppVeyor Build Status][appveyor-image]][appveyor-url]
+
+[markdown-it](https://www.npmjs.com/package/markdown-it) plugin which wraps table into div and add class for custom styling.
+
+## Install
+
+Via `npm`
+
+```bash
+npm install markdown-it-table-wrap
+```
+
+Via Yarn
+
+```bash
+yarn add markdown-it-table-wrap
+```
+
+## Usage
+
+```javascript
+const markdownit = require('markdown-it');
+const markdownitTableWrap = require('markdown-it-table-wrap').default;
+const md = markdownit();
+
+const testString = `
+| Syntax      | Description |
+| ----------- | ----------- |
+| Header      | Title       |
+| Paragraph   | Text        |
+`;
+
+md.use(markdownitTableWrap);
+
+console.log(md.render(testString));
+```
+
+[npm-image]: https://img.shields.io/npm/v/markdown-it-table-wrap.svg
+[npm-url]: https://www.npmjs.com/package/markdown-it-table-wrap
+[downloads-image]: https://img.shields.io/npm/dm/markdown-it-table-wrap.svg
+
+[appveyor-url]: https://ci.appveyor.com/project/trunkcode/markdown-it-table-wrap
+[appveyor-image]: https://img.shields.io/appveyor/ci/trunkcode/markdown-it-table-wrap.svg?label=appveyor

appveyor.yml

@@ -0,0 +1,23 @@
+version: "{build}"
+
+# branches to build
+branches:
+  only:
+    - main
+
+environment:
+  matrix:
+    # node.js
+    - nodejs_version: "16"
+    - nodejs_version: "18"
+    - nodejs_version: ""
+
+install:
+  - ps: Install-Product node $env:nodejs_version
+  - npm install
+
+test_script:
+  - npm run lint
+  - npm run test
+
+build: off

dist/cjs/index.d.ts

@@ -0,0 +1,3 @@
+import markdownit from 'markdown-it';
+
+export default function markdownitTableWrap (md: markdownit): void;

dist/cjs/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+function markdownitTableWrap(md) {
+    md.renderer.rules.table_open = function () {
+        return '<div class="table-responsive"><table class="table table-striped">';
+    };
+    md.renderer.rules.table_close = function () {
+        return '</table></div>';
+    };
+}
+exports.default = markdownitTableWrap;

dist/cjs/index.test-d.ts

@@ -0,0 +1,16 @@
+'use strict';
+
+import markdownit from 'markdown-it';
+import markdownitTableWrap from './index';
+
+const testString = `
+| Syntax      | Description |
+| ----------- | ----------- |
+| Header      | Title       |
+| Paragraph   | Text        |
+`;
+
+const md = new markdownit();
+
+md.use(markdownitTableWrap);
+md.render(testString);

dist/cjs/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

dist/esm/index.d.ts

@@ -0,0 +1,3 @@
+import markdownit from 'markdown-it';
+
+export default function markdownitTableWrap (md: markdownit): void;

dist/esm/index.js

@@ -0,0 +1,8 @@
+export default function markdownitTableWrap(md) {
+    md.renderer.rules.table_open = function () {
+        return '<div class="table-responsive"><table class="table table-striped">';
+    };
+    md.renderer.rules.table_close = function () {
+        return '</table></div>';
+    };
+}

dist/esm/index.test-d.ts

@@ -0,0 +1,16 @@
+'use strict';
+
+import markdownit from 'markdown-it';
+import markdownitTableWrap from './index';
+
+const testString = `
+| Syntax      | Description |
+| ----------- | ----------- |
+| Header      | Title       |
+| Paragraph   | Text        |
+`;
+
+const md = new markdownit();
+
+md.use(markdownitTableWrap);
+md.render(testString);

dist/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

fixup

@@ -0,0 +1,19 @@
+#!/bin/bash
+#
+# Add package.json files to cjs/esm subtrees.
+#
+
+cat >dist/cjs/package.json <<!EOF
+{
+  "type": "commonjs"
+}
+!EOF
+
+cat >dist/esm/package.json <<!EOF
+{
+  "type": "module"
+}
+!EOF
+
+find types -name '*d.ts' -exec cp {} dist/esm \;
+find types -name '*d.ts' -exec cp {} dist/cjs \;