@flex-development/docmark-factory-space 1.0.0-alpha.1

package/LICENSE.md

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2024, Flex Development, LLC All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,107 @@
+# docmark-factory-space
+
+[![npm](https://img.shields.io/npm/v/@flex-development/docmark-factory-space.svg)](https://npmjs.com/package/@flex-development/docmark-factory-space)
+[![npm downloads](https://img.shields.io/npm/dm/@flex-development/docmark-factory-space.svg)](https://www.npmcharts.com/compare/@flex-development/docmark-factory-space?interval=30)
+[![install size](https://packagephobia.now.sh/badge?p=@flex-development/docmark-factory-space)](https://packagephobia.now.sh/result?p=@flex-development/docmark-factory-space)
+[![minified bundle size](https://badgen.net/bundlephobia/min/@flex-development/docmark-factory-space?cache)](https://bundlephobia.com/package/@flex-development/docmark-factory-space)
+[![tree shaking suppport](https://badgen.net/bundlephobia/tree-shaking/@flex-development/docmark-factory-space)](https://bundlephobia.com/package/@flex-development/docmark-factory-space)
+[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
+[![license](https://img.shields.io/github/license/flex-development/docmark-factory-space.svg)](LICENSE.md)
+[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript\&logoColor=ffffff)](https://typescriptlang.org)
+[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat\&logo=yarn\&logoColor=ffffff)](https://yarnpkg.com)
+
+[docmark][] factory to parse [docdown space][ws].
+
+## Contents
+
+- [What is this?](#what-is-this)
+- [When should I use this?](#when-should-i-use-this)
+- [Install](#install)
+- [Use](#use)
+- [API](#api)
+- [Types](#types)
+- [Contribute](#contribute)
+
+## What is this?
+
+This package exposes states to parse spaces and/or tabs.
+
+## When should I use this?
+
+This package may be useful when making your own docmark extensions.
+
+## Install
+
+This package is [ESM only][esm].
+
+In Node.js with [yarn][]:
+
+```sh
+yarn add @flex-development/docmark-factory-space
+```
+
+<blockquote>
+  <small>
+    See <a href='https://yarnpkg.com/protocol/git'>Git - Protocols | Yarn</a>
+    &nbsp;for details regarding installing from Git.
+  </small>
+</blockquote>
+
+In Deno with [`esm.sh`][esmsh]:
+
+```ts
+import { factorySpace } from 'https://esm.sh/@flex-development/docmark-factory-space'
+```
+
+In browsers with [`esm.sh`][esmsh]:
+
+```html
+<script type="module">
+  import { factorySpace } from 'https://esm.sh/@flex-development/docmark-factory-space'
+</script>
+```
+
+## Use
+
+**TODO**: use
+
+## API
+
+**TODO**: api
+
+## Types
+
+This package is fully typed with [TypeScript][].
+It exports no additional types.
+
+## Project
+
+### Version
+
+docmark-factory-space adheres to [semver][].
+
+### Contribute
+
+See [`CONTRIBUTING.md`](../../CONTRIBUTING.md).
+
+This project has a [code of conduct](../../CODE_OF_CONDUCT.md).
+By interacting with this repository, organization, or community you agree to abide by its terms.
+
+### Sponsor
+
+Small primitives power larger systems.
+Support long-term stability by sponsoring Flex Development.
+
+[docmark]: ../../README.md
+
+[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
+
+[esmsh]: https://esm.sh
+
+[semver]: https://semver.org
+
+[typescript]: https://www.typescriptlang.org
+
+[ws]: https://github.com/micromark/micromark/tree/main/packages/micromark-util-character#markdownlineendingorspacecode
+
+[yarn]: https://yarnpkg.com

package/dist/index.d.mts

@@ -0,0 +1,30 @@
+import type { Effects, State, TokenType } from '@flex-development/docmark-util-types';
+import type * as micromark from 'micromark-util-types';
+
+/**
+ * @file factorySpace
+ * @module docmark-factory-space/factory
+ */
+
+/**
+ * Tokenize spaces and tabs.
+ *
+ * @see {@linkcode Effects}
+ * @see {@linkcode State}
+ * @see {@linkcode TokenType}
+ * @see {@linkcode micromark.Effects}
+ *
+ * @param {Effects | micromark.Effects} effects
+ *  The context object used to transition the state machine
+ * @param {State} ok
+ *  The successful tokenization state
+ * @param {TokenType | null | undefined} [type]
+ *  The token type to capture whitespace as
+ * @param {number | null | undefined} [max]
+ *  The maximum number of spaces/tabs to consume (exclusive)
+ * @return {State}
+ *  The initial state
+ */
+declare function factorySpace(effects: Effects | micromark.Effects, ok: State, type?: TokenType | null | undefined, max?: number | null | undefined): State;
+
+export { factorySpace };

package/dist/index.mjs

@@ -0,0 +1,22 @@
+import { whitespace } from '@flex-development/mark-util-character';
+
+function factorySpace(effects, ok, type, max) {
+    const limit = max ? max - 1 : Number.POSITIVE_INFINITY;
+    let size = 0;
+    return maybeWhitespace;
+    function maybeWhitespace(code) {
+        if (!whitespace(code))
+            return ok(code);
+        return type && effects.enter(type), insideWhitespace(code);
+    }
+    function insideWhitespace(code) {
+        if (whitespace(code) && size++ < limit) {
+            effects.consume(code);
+            return insideWhitespace;
+        }
+        type && effects.exit(type);
+        return ok(code);
+    }
+}
+
+export { factorySpace };

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@flex-development/docmark-factory-space",
+  "description": "docmark factory to parse docmark space",
+  "version": "1.0.0-alpha.1",
+  "keywords": [
+    "docmark",
+    "factory",
+    "space",
+    "typescript"
+  ],
+  "license": "BSD-3-Clause",
+  "homepage": "https://github.com/flex-development/docmark-util-types/tree/main/packages/flex-development/docmark-factory-space",
+  "repository": {
+    "directory": "packages/docmark-factory-space",
+    "type": "git",
+    "url": "git+https://github.com/flex-development/docmark.git"
+  },
+  "bugs": "https://github.com/flex-development/docmark/issues",
+  "author": {
+    "name": "Lexus Drumgold",
+    "url": "https://github.com/unicornware"
+  },
+  "publishConfig": {
+    "access": "public",
+    "diff-dst-prefix": "docmark-factory-space",
+    "diff-src-prefix": "docmark-factory-space",
+    "directory": "./",
+    "executableFiles": [],
+    "node-options": null,
+    "pack-destination": ".",
+    "parseable": true,
+    "prefer-dedupe": true,
+    "provenance": true,
+    "tag-version-prefix": "docmark-factory-space"
+  },
+  "type": "module",
+  "files": [
+    "LICENSE.md",
+    "README.md",
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "docmark": "./src/index.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "dependencies": {
+    "@flex-development/docmark-util-types": "1.0.0-alpha.1",
+    "@flex-development/mark-util-character": "1.1.0",
+    "micromark-util-types": "2.0.2"
+  },
+  "sideEffects": false,
+  "build": "524f7d653272a777cde27efaac4656fb90cd4855"
+}