@storm-software/markdownlint 0.1.0

package/.eslintrc.json

@@ -0,0 +1,37 @@
+{
+  "extends": ["../../.eslintrc.base.json"],
+  "ignorePatterns": ["!**/*", "node_modules/*"],
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx", "*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.ts", "*.tsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.js", "*.jsx"],
+      "rules": {}
+    },
+    {
+      "files": ["*.json"],
+      "parser": "jsonc-eslint-parser",
+      "rules": {
+        "@nx/dependency-checks": [
+          "error",
+          {
+            "buildTargets": ["build"],
+            "ignoredFiles": [
+              "{projectRoot}/esbuild.config.{js,ts,mjs,mts}",
+              "{projectRoot}/jest.config.ts"
+            ],
+            "checkMissingDependencies": true,
+            "checkObsoleteDependencies": true,
+            "checkVersionMismatches": false
+          }
+        ]
+      }
+    }
+  ]
+}

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+## 0.1.0 (2024-05-06)
+
+
+### 🚀 Features
+
+- **markdownlint:** Added the `markdownlint` package for shared configurations ([abd6fa38](https://github.com/storm-software/storm-ops/commit/abd6fa38))
+
+
+### ❤️  Thank You
+
+- Patrick Sullivan

package/README.md

@@ -0,0 +1,217 @@
+<!-- START header -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+<div align="center"><img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/storm-banner.gif" width="100%" alt="Storm Software" /></div>
+<br />
+
+<div align="center">
+<b>
+<a href="https://stormsoftware.com" target="_blank">Website</a>  •   
+<a href="https://github.com/storm-software/storm-ops" target="_blank">GitHub</a>  •   
+<a href="https://discord.gg/MQ6YVzakM5">Discord</a>  •   <a href="https://stormstack.github.io/stormstack/" target="_blank">Docs</a>  •   <a href="https://stormsoftware.com/contact" target="_blank">Contact</a>  •   
+<a href="https://github.com/storm-software/storm-ops/issues/new?assignees=&labels=bug&template=bug-report.yml&title=Bug Report%3A+">Report a Bug</a>
+</b>
+</div>
+
+<br />
+This package is part of the <b>⚡Storm-Ops</b> monorepo. The Storm-Ops packages include CLI utility applications, tools, and various libraries used to create modern, scalable web applications.
+<br />
+
+<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3><br />
+
+[![Version](https://img.shields.io/badge/version-2.9.4-1fb2a6.svg?style=for-the-badge&color=1fb2a6)](https://prettier.io/)&nbsp;
+[![Nx](https://img.shields.io/badge/Nx-17.0.2-lightgrey?style=for-the-badge&logo=nx&logoWidth=20&&color=1fb2a6)](http://nx.dev/)&nbsp;[![NextJs](https://img.shields.io/badge/Next.js-14.0.2-lightgrey?style=for-the-badge&logo=nextdotjs&logoWidth=20&color=1fb2a6)](https://nextjs.org/)&nbsp;[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=for-the-badge&logo=commitlint&color=1fb2a6)](http://commitizen.github.io/cz-cli/)&nbsp;![Semantic-Release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge&color=1fb2a6)&nbsp;[![documented with docusaurus](https://img.shields.io/badge/documented_with-docusaurus-success.svg?style=for-the-badge&logo=readthedocs&color=1fb2a6)](https://docusaurus.io/)&nbsp;![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/storm-software/storm-ops/cr.yml?style=for-the-badge&logo=github-actions&color=1fb2a6)
+
+> [!IMPORTANT]
+> This repository, and the apps, libraries, and tools contained within, is still in it's initial development phase. As a result, bugs and issues are expected with it's usage. When the main development phase completes, a proper release will be performed, the packages will be availible through NPM (and other distributions), and this message will be removed. However, in the meantime, please feel free to report any issues you may come across.
+
+<br />
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END header -->
+
+# Storm Markdownlint Rules
+
+An opinionated collection of markdownlint rules used by Storm Software. This package includes the rules used by GitHub in the [markdownlint-github](https://github.com/github/markdownlint-github) package, as well as additional rules that are specific to Storm Software.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installing
+
+Using [pnpm](http://pnpm.io):
+
+```bash
+pnpm add -D @storm-software/markdownlint
+```
+
+<details>
+  <summary>Using npm</summary>
+
+```bash
+npm install -D @storm-software/markdownlint
+```
+
+</details>
+
+<details>
+  <summary>Using yarn</summary>
+
+```bash
+yarn add -D @storm-software/markdownlint
+```
+
+</details>
+
+## Building
+
+Run `nx build markdownlint` to build the library.
+
+## Running unit tests
+
+Run `nx test markdownlint` to execute the unit tests via [Jest](https://jestjs.io).
+
+<!-- START footer -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+
+
+## Storm Workspaces
+
+Storm workspaces are built using <a href="https://nx.dev/" target="_blank">Nx</a>, a set of extensible dev tools for monorepos, which helps you develop like Google, Facebook, and Microsoft. Building on top of Nx, the Open System provides a set of tools and patterns that help you scale your monorepo to many teams while keeping the codebase maintainable.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Roadmap
+
+See the [open issues](https://github.com/storm-software/storm-ops/issues) for a list of proposed features (and known issues).
+
+- [Top Feature Requests](https://github.com/storm-software/storm-ops/issues?q=label%3Aenhancement+is%3Aopen+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
+- [Top Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Areactions-%2B1-desc) (Add your votes using the 👍 reaction)
+- [Newest Bugs](https://github.com/storm-software/storm-ops/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Support
+
+Reach out to the maintainer at one of the following places:
+
+- [Contact](https://stormsoftware.com/contact)
+- [GitHub discussions](https://github.com/storm-software/storm-ops/discussions)
+- <support@stormsoftware.com>
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## License
+
+This project is licensed under the **Apache License 2.0**. Feel free to edit and distribute this template as you like.
+
+See [LICENSE](LICENSE) for more information.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Changelog
+
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). Every release, along with the migration instructions, is documented in the [CHANGELOG](CHANGELOG.md) file
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Contributing
+
+First off, thanks for taking the time to contribute! Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are **greatly appreciated**.
+
+Please try to create bug reports that are:
+
+- _Reproducible._ Include steps to reproduce the problem.
+- _Specific._ Include as much detail as possible: which version, what environment, etc.
+- _Unique._ Do not duplicate existing opened issues.
+- _Scoped to a Single Bug._ One bug per report.
+
+Please adhere to this project's [code of conduct](.github/CODE_OF_CONDUCT.md).
+
+You can use [markdownlint-cli](https://github.com/storm-software/storm-ops/markdownlint-cli) to check for common markdown style inconsistency.
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+## Contributors
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+
+<table>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="http://www.sullypat.com/"><img src="https://avatars.githubusercontent.com/u/99053093?v=4?s=100" width="100px;" alt="Patrick Sullivan"/><br /><sub><b>Patrick Sullivan</b></sub></a><br /><a href="#design-sullivanpj" title="Design">🎨</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Code">💻</a> <a href="#tool-sullivanpj" title="Tools">🔧</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Documentation">📖</a> <a href="https://github.com/storm-software/storm-ops/commits?author=sullivanpj" title="Tests">⚠️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://tylerbenning.com/"><img src="https://avatars.githubusercontent.com/u/7265547?v=4?s=100" width="100px;" alt="Tyler Benning"/><br /><sub><b>Tyler Benning</b></sub></a><br /><a href="#design-tbenning" title="Design">🎨</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="http://stormsoftware.com"><img src="https://avatars.githubusercontent.com/u/149802440?v=4?s=100" width="100px;" alt="Stormie"/><br /><sub><b>Stormie</b></sub></a><br /><a href="#maintenance-stormie-bot" title="Maintenance">🚧</a></td>
+    </tr>
+  </tbody>
+  <tfoot>
+    <tr>
+      <td align="center" size="13px" colspan="7">
+        <img src="https://raw.githubusercontent.com/all-contributors/all-contributors-cli/1b8533af435da9854653492b1327a23a4dbd0a10/assets/logo-small.svg" alt="All Contributors">
+          <a href="https://all-contributors.js.org/docs/en/bot/usage">Add your contributions</a>
+        </img>
+      </td>
+    </tr>
+  </tfoot>
+</table>
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+<hr />
+<br />
+
+<div align="center">
+<img src="https://pub-761b436209f44a4d886487c917806c08.r2.dev/logo-banner.png" width="100%" alt="Storm Software" />
+</div>
+<br />
+
+<div align="center">
+<b>
+<a href="https://stormsoftware.com" target="_blank">Website</a>   •   <a href="https://stormsoftware.com/contact" target="_blank">Contact</a>  •   <a href="https://discord.gg/MQ6YVzakM5">Discord</a>  •   <a href="https://linkedin.com/in/pat-sullivan-dev" target="_blank">LinkedIn</a>  •   <a href="https://medium.com/@pat.joseph.sullivan" target="_blank">Medium</a>  •   <a href="https://github.com/storm-software" target="_blank">GitHub</a>  •   <a href="https://keybase.io/sullivanp" target="_blank">OpenPGP Key</a>
+</b>
+</div>
+
+<div align="center">
+<b>Fingerprint:</b> 1BD2 7192 7770 2549 F4C9 F238 E6AD C420 DA5C 4C2D
+</div>
+<br />
+
+Storm Software is an open source software development organization and creator of Acidic, StormStack and StormCloud.
+
+Our mission is to make software development more accessible. Our ideal future is one where anyone can create software without years of prior development experience serving as a barrier to entry. We hope to achieve this via LLMs, Generative AI, and intuitive, high-level data modeling/programming languages.
+
+If this sounds interesting, and you would like to help us in creating the next generation of development tools, please reach out on our website!
+
+<br />
+<h3 align="center">💻 Visit <a href="https://stormsoftware.com" target="_blank">stormsoftware.com</a> to stay up to date with this developer</h3>
+
+<br />
+<div align="right">[ <a href="#table-of-contents">Back to top ▲</a> ]</div>
+<br />
+
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- END footer -->

package/jest.config.ts

@@ -0,0 +1,3 @@
+import { getJestConfig } from "@storm-software/testing-tools";
+
+export default getJestConfig("packages/markdownlint", true, "markdownlint");

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@storm-software/markdownlint",
+  "version": "0.1.0",
+  "private": false,
+  "description": "⚡An opinionated collection of markdownlint rules used by Storm Software.",
+  "keywords": [
+    "storm",
+    "storm-ops",
+    "stormstack",
+    "storm-stack",
+    "sullivanpj",
+    "open-system",
+    "monorepo",
+    "markdownlint",
+    "markdownlint-cli",
+    "markdownlint-cli2"
+  ],
+  "homepage": "https://stormsoftware.com",
+  "bugs": {
+    "url": "https://github.com/storm-software/storm-ops/issues",
+    "email": "support@stormsoftware.com"
+  },
+  "repository": {
+    "type": "github",
+    "url": "https://github.com/storm-software/storm-ops.git",
+    "directory": "packages/markdownlint"
+  },
+  "license": "Apache-2.0",
+  "author": {
+    "name": "Storm Software",
+    "email": "contact@stormsoftware.com",
+    "url": "https://stormsoftware.com"
+  },
+  "type": "module",
+  "dependencies": {
+    "lodash": "^4.17.21"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/project.json

@@ -0,0 +1,57 @@
+{
+  "name": "markdownlint",
+  "$schema": "../../node_modules/nx/schemas/project-schema.json",
+  "projectType": "library",
+  "sourceRoot": "packages/markdownlint/src",
+  "targets": {
+    "build": {
+      "executor": "@nx/esbuild:esbuild",
+      "outputs": ["{options.outputPath}"],
+      "options": {
+        "outputPath": "dist/packages/markdownlint",
+        "tsConfig": "packages/markdownlint/tsconfig.json",
+        "project": "packages/markdownlint/package.json",
+        "main": "packages/markdownlint/src/index.ts",
+        "defaultConfiguration": "production",
+        "deleteOutputPath": true,
+        "sourcemap": false,
+        "minify": false,
+        "skipTypeCheck": true,
+        "platform": "node",
+        "format": ["cjs"],
+        "esbuildOptions": {
+          "outExtension": {
+            ".js": ".js"
+          }
+        },
+        "assets": [
+          {
+            "input": "packages/markdownlint",
+            "glob": "README.md",
+            "output": "."
+          },
+          {
+            "input": "packages/markdownlint",
+            "glob": "CHANGELOG.md",
+            "output": "."
+          },
+          {
+            "input": "",
+            "glob": "LICENSE",
+            "output": "."
+          }
+        ]
+      },
+      "configurations": {
+        "production": {
+          "debug": false,
+          "verbose": false
+        },
+        "development": {
+          "debug": true,
+          "verbose": true
+        }
+      }
+    }
+  }
+}

package/src/index.ts

@@ -0,0 +1,26 @@
+/**
+ * The markdownlint library used by Storm Software for building TypeScript applications.
+ *
+ * @remarks
+ * An opinionated collection of markdownlint rules used by Storm Software.
+ *
+ * @packageDocumentation
+ */
+
+import _ from "lodash";
+import accessibilityRules from "./style/accessibility.json";
+import base from "./style/base.json";
+import { rules } from "./rules";
+
+const offByDefault = ["no-empty-alt-text"];
+
+for (const rule of rules) {
+  const ruleName = rule.names[1];
+  base[ruleName] = offByDefault.includes(ruleName) ? false : true;
+}
+
+export const init = function init(defaultConfig) {
+  return _.defaultsDeep(defaultConfig, accessibilityRules, base);
+};
+
+export default [...rules];

package/src/rules/index.ts

@@ -0,0 +1,5 @@
+import SS01 from "./no-default-alt-text";
+import SS02 from "./no-generic-link-text";
+import SS03 from "./no-empty-alt-text";
+
+export const rules = [SS01, SS02, SS03];

package/src/rules/no-default-alt-text.ts

@@ -0,0 +1,69 @@
+/**
+ * Examples:
+ * * "Screen Shot 2020-10-20 at 2 52 27 PM"
+ * * "Screenshot 2020-10-20 at 2 52 27 PM"
+ * * "Clean Shot 2020-10-20 @45x"
+ * * "Screencast from 23 02 2024 19 15 19]"
+ */
+const defaultScreenshotRegex =
+  "(?:screen|clean) ?(?:shot|cast) \\d{4}-\\d{2}-\\d{2}[^'\"\\]]*";
+
+const imageRegex = "image";
+const combinedRegex = `(${[defaultScreenshotRegex, imageRegex].join("|")})`;
+
+const markdownAltRegex = new RegExp(`!\\[${combinedRegex}\\]\\(.*\\)`, "gid");
+const htmlAltRegex = new RegExp(`alt=["']${combinedRegex}["']`, "gid");
+
+export default {
+  names: ["SS001", "no-default-alt-text"],
+  description: "Images should have meaningful alternative text (alt text)",
+  information: new URL(
+    "https://github.com/github/markdownlint-github/blob/main/docs/rules/GH001-no-default-alt-text.md"
+  ),
+  tags: ["accessibility", "images"],
+  function: function SS001(params, onError) {
+    const htmlTagsWithImages = params.parsers.markdownit.tokens.filter(
+      token => {
+        return (
+          (token.type === "html_block" && token.content.includes("<img")) ||
+          (token.type === "inline" &&
+            token.content.includes("<img") &&
+            token.children.some(child => child.type === "html_inline"))
+        );
+      }
+    );
+    const inlineImages = params.parsers.markdownit.tokens.filter(
+      token =>
+        token.type === "inline" &&
+        token.children.some(child => child.type === "image")
+    );
+
+    for (const token of [...htmlTagsWithImages, ...inlineImages]) {
+      const lineRange = token.map;
+      const lineNumber = token.lineNumber;
+      const lines = params.lines.slice(lineRange[0], lineRange[1]);
+      for (let i = 0; i < lines.length; i++) {
+        const line = lines[i];
+        let matches;
+        if (token.type === "inline") {
+          if (token.children.some(child => child.type === "html_inline")) {
+            matches = line.matchAll(htmlAltRegex);
+          } else {
+            matches = line.matchAll(markdownAltRegex);
+          }
+        } else {
+          matches = line.matchAll(htmlAltRegex);
+        }
+        for (const match of matches) {
+          const altText = match[1];
+          const [startIndex] = match.indices[1];
+          onError({
+            lineNumber: lineNumber + i,
+            range: [startIndex + 1, altText.length],
+            detail: `Flagged alt: ${altText}`
+          });
+        }
+      }
+    }
+  }
+};

package/src/rules/no-empty-alt-text.ts

@@ -0,0 +1,48 @@
+export default {
+  names: ["SS003", "no-empty-alt-text"],
+  description: "Please provide an alternative text for the image.",
+  information: new URL(
+    "https://github.com/github/markdownlint-github/blob/main/docs/rules/GH003-no-empty-alt-text.md"
+  ),
+  tags: ["accessibility", "images"],
+  function: function SS003(params, onError) {
+    const htmlTagsWithImages = params.parsers.markdownit.tokens.filter(
+      token => {
+        return (
+          (token.type === "html_block" && token.content.includes("<img")) ||
+          (token.type === "inline" &&
+            token.content.includes("<img") &&
+            token.children.some(child => child.type === "html_inline"))
+        );
+      }
+    );
+
+    const ImageRegex = new RegExp(/<img(.*?)>/, "gid");
+    const htmlEmptyAltRegex = new RegExp(/alt=['"]['"]/, "gid");
+    for (const token of htmlTagsWithImages) {
+      const lineRange = token.map;
+      const lineNumber = token.lineNumber;
+      const lines = params.lines.slice(lineRange[0], lineRange[1]);
+
+      for (const [i, line] of lines.entries()) {
+        const imageTags = line.matchAll(ImageRegex);
+
+        for (const imageTag of imageTags) {
+          const imageTagIndex = imageTag.indices[0][0];
+
+          const emptyAltMatches = [
+            ...imageTag[0].matchAll(htmlEmptyAltRegex)
+          ][0];
+          if (emptyAltMatches) {
+            const matchingContent = emptyAltMatches[0];
+            const startIndex = emptyAltMatches.indices[0][0];
+            onError({
+              lineNumber: lineNumber + i,
+              range: [imageTagIndex + startIndex + 1, matchingContent.length]
+            });
+          }
+        }
+      }
+    }
+  }
+};

package/src/rules/no-generic-link-text.ts

@@ -0,0 +1,62 @@
+function stripAndDowncaseText(text) {
+  return text
+    .toLowerCase()
+    .replace(/[.,/#!$%^&*;:{}=\-_`~()]/g, "")
+    .replace(/\s+/g, " ")
+    .trim();
+}
+
+const bannedLinkText = [
+  "read more",
+  "learn more",
+  "more",
+  "here",
+  "click here",
+  "link"
+];
+
+export default {
+  names: ["SS002", "no-generic-link-text"],
+  description:
+    "Avoid using generic link text like `Learn more` or `Click here`",
+  information: new URL(
+    "https://github.com/github/markdownlint-github/blob/main/docs/rules/GH002-no-generic-link-text.md"
+  ),
+  tags: ["accessibility", "links"],
+  function: function SS002(params, onError) {
+    // markdown syntax
+    let bannedLinkTexts = bannedLinkText.concat(
+      params.config.additional_banned_texts || []
+    );
+    const exceptions = params.config.exceptions || [];
+    if (exceptions.length > 0) {
+      bannedLinkTexts = bannedLinkTexts.filter(
+        text => !exceptions.includes(text)
+      );
+    }
+    const inlineTokens = params.tokens.filter(t => t.type === "inline");
+    for (const token of inlineTokens) {
+      const { children } = token;
+      let inLink = false;
+      let linkText = "";
+
+      for (const child of children) {
+        const { content, type } = child;
+        if (type === "link_open") {
+          inLink = true;
+          linkText = "";
+        } else if (type === "link_close") {
+          inLink = false;
+          if (bannedLinkTexts.includes(stripAndDowncaseText(linkText))) {
+            onError({
+              lineNumber: child.lineNumber,
+              detail: `For link: ${linkText}`
+            });
+          }
+        } else if (inLink) {
+          linkText += content;
+        }
+      }
+    }
+  }
+};

package/src/style/accessibility.json

@@ -0,0 +1,14 @@
+{
+  "no-alt-text": true,
+  "no-default-alt-text": true,
+  "no-duplicate-header": true,
+  "no-emphasis-as-header": true,
+  "no-generic-link-text": true,
+  "heading-increment": true,
+  "no-space-in-links": false,
+  "ol-prefix": "ordered",
+  "single-h1": true,
+  "ul-style": {
+    "style": "asterisk"
+  }
+}

package/src/style/base.json

@@ -0,0 +1,12 @@
+{
+  "default": true,
+  "no-inline-html": false,
+  "no-bare-urls": false,
+  "no-alt-text": true,
+  "no-blanks-blockquote": false,
+  "fenced-code-language": true,
+  "heading-increment": true,
+  "single-h1": true,
+  "no-emphasis-as-header": true,
+  "first-line-heading": false
+}

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "resolveJsonModule": true,
+    "noEmit": true
+  },
+  "files": [],
+  "include": ["src/**/*.ts", "src/**/*.js", "bin/**/*"],
+  "exclude": ["jest.config.ts", "src/**/*.spec.ts", "src/**/*.test.ts"]
+}

package/tsconfig.spec.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "../../dist/out-tsc",
+    "types": ["jest", "node"]
+  },
+  "include": [
+    "jest.config.ts",
+    "src/**/*.test.ts",
+    "src/**/*.spec.ts",
+    "src/**/*.d.ts"
+  ]
+}