@markuplint/shared 3.5.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2019 Yusuke Hirao
+
+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,18 @@
+# @markuplint/shared
+
+[![npm version](https://badge.fury.io/js/%40markuplint%2Fshared.svg)](https://www.npmjs.com/package/@markuplint/shared)
+
+## Install
+
+[`markuplint`](https://www.npmjs.com/package/markuplint) package includes this package.
+
+<details>
+<summary>If you are installing purposely, how below:</summary>
+
+```shell
+$ npm install @markuplint/shared
+
+$ yarn add @markuplint/shared
+```
+
+</details>

package/lib/functions.d.ts

@@ -0,0 +1,61 @@
+import type { Nullable } from './types';
+/**
+ * Converts a given value of string, string array, null, or undefined
+ * into an array of non-empty strings.
+ *
+ * If a string is provided, it wraps it into an array. If null or undefined
+ * is provided, an empty array is returned.
+ *
+ * @param value The input value to be converted to a non-empty string array.
+ * @returns The resulting array of non-empty strings derived from the input value.
+ */
+export declare function toNoEmptyStringArrayFromStringOrArray(value: string | readonly string[] | null | undefined): readonly string[];
+/**
+ * Converts a given value of an item or an array of items into
+ * an array of non-nullable items.
+ *
+ * @template T The type of the items in the input value.
+ * @param value The input value to be converted to a non-nullable item array.
+ * @returns The resulting array of non-nullable items derived from the input value.
+ */
+export declare function toNonNullableArrayFromItemOrArray<T>(value: T | readonly T[]): readonly NonNullable<T>[];
+/**
+ * A filter function for use with the `Array.filter` method,
+ * which determines if the given string item is non-empty.
+ *
+ * @param item The string item to be checked for non-emptiness.
+ * @returns Returns true if the item is a non-empty string, otherwise false.
+ */
+export declare function noEmptyFilter(item: string): item is string;
+/**
+ * A filter function for use with the Array.filter method,
+ * which determines if the given item is non-nullable.
+ *
+ * @template T The type of the items in the array.
+ * @param item The item to be checked for non-nullability.
+ * @returns Returns true if the item is non-nullable, otherwise false.
+ */
+export declare function nonNullableFilter<T>(item: Nullable<T>): item is T;
+/**
+ * Decodes the provided text by replacing HTML entities
+ * with their corresponding characters.
+ *
+ * The decoding process uses the 'html5' (HTML Standard) level.
+ *
+ * Unknown entities are left as they are.
+ *
+ * @param text The input text containing HTML entities to be decoded.
+ * @returns The decoded text with HTML entities replaced by their corresponding characters.
+ */
+export declare function decodeEntities(text: string): string;
+/**
+ * Decodes the provided URL string (href) using
+ * the `decodeURIComponent` function.
+ *
+ * If a `URIError` is encountered,
+ * the original href is returned. Any other errors are propagated.
+ *
+ * @param href The URL string to be decoded.
+ * @returns The decoded URL string or the original href if a `URIError` occurs.
+ */
+export declare function decodeHref(href: string): string;

package/lib/functions.js

@@ -0,0 +1,93 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeHref = exports.decodeEntities = exports.nonNullableFilter = exports.noEmptyFilter = exports.toNonNullableArrayFromItemOrArray = exports.toNoEmptyStringArrayFromStringOrArray = void 0;
+const html_entities_1 = require("html-entities");
+/**
+ * Converts a given value of string, string array, null, or undefined
+ * into an array of non-empty strings.
+ *
+ * If a string is provided, it wraps it into an array. If null or undefined
+ * is provided, an empty array is returned.
+ *
+ * @param value The input value to be converted to a non-empty string array.
+ * @returns The resulting array of non-empty strings derived from the input value.
+ */
+function toNoEmptyStringArrayFromStringOrArray(value) {
+    const array = typeof value === 'string' ? [value] : value !== null && value !== void 0 ? value : [];
+    return array.filter(noEmptyFilter);
+}
+exports.toNoEmptyStringArrayFromStringOrArray = toNoEmptyStringArrayFromStringOrArray;
+/**
+ * Converts a given value of an item or an array of items into
+ * an array of non-nullable items.
+ *
+ * @template T The type of the items in the input value.
+ * @param value The input value to be converted to a non-nullable item array.
+ * @returns The resulting array of non-nullable items derived from the input value.
+ */
+function toNonNullableArrayFromItemOrArray(value) {
+    const array = Array.isArray(value) ? value : [value];
+    // @ts-ignore
+    return array.filter(nonNullableFilter);
+}
+exports.toNonNullableArrayFromItemOrArray = toNonNullableArrayFromItemOrArray;
+/**
+ * A filter function for use with the `Array.filter` method,
+ * which determines if the given string item is non-empty.
+ *
+ * @param item The string item to be checked for non-emptiness.
+ * @returns Returns true if the item is a non-empty string, otherwise false.
+ */
+function noEmptyFilter(item) {
+    return item !== '';
+}
+exports.noEmptyFilter = noEmptyFilter;
+/**
+ * A filter function for use with the Array.filter method,
+ * which determines if the given item is non-nullable.
+ *
+ * @template T The type of the items in the array.
+ * @param item The item to be checked for non-nullability.
+ * @returns Returns true if the item is non-nullable, otherwise false.
+ */
+function nonNullableFilter(item) {
+    return item != null;
+}
+exports.nonNullableFilter = nonNullableFilter;
+/**
+ * Decodes the provided text by replacing HTML entities
+ * with their corresponding characters.
+ *
+ * The decoding process uses the 'html5' (HTML Standard) level.
+ *
+ * Unknown entities are left as they are.
+ *
+ * @param text The input text containing HTML entities to be decoded.
+ * @returns The decoded text with HTML entities replaced by their corresponding characters.
+ */
+function decodeEntities(text) {
+    return (0, html_entities_1.decode)(text, { level: 'html5' });
+}
+exports.decodeEntities = decodeEntities;
+/**
+ * Decodes the provided URL string (href) using
+ * the `decodeURIComponent` function.
+ *
+ * If a `URIError` is encountered,
+ * the original href is returned. Any other errors are propagated.
+ *
+ * @param href The URL string to be decoded.
+ * @returns The decoded URL string or the original href if a `URIError` occurs.
+ */
+function decodeHref(href) {
+    try {
+        return decodeURIComponent(href);
+    }
+    catch (e) {
+        if (e instanceof URIError) {
+            return href;
+        }
+        throw e;
+    }
+}
+exports.decodeHref = decodeHref;

package/lib/index.d.ts

@@ -0,0 +1,2 @@
+export * from './functions';
+export * from './types';

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./functions"), exports);
+tslib_1.__exportStar(require("./types"), exports);

package/lib/types.d.ts

@@ -0,0 +1 @@
+export type Nullable<T> = T | null | undefined;

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,25 @@
+{
+	"name": "@markuplint/shared",
+	"version": "3.5.0",
+	"description": "Shared functions for Markuplint",
+	"repository": "git@github.com:markuplint/markuplint.git",
+	"author": "Yusuke Hirao <yusukehirao@me.com>",
+	"license": "MIT",
+	"private": false,
+	"main": "lib/index.js",
+	"types": "lib/index.d.ts",
+	"publishConfig": {
+		"access": "public"
+	},
+	"typedoc": {
+		"entryPoint": "./src/index.ts"
+	},
+	"scripts": {
+		"build": "tsc",
+		"clean": "tsc --build --clean"
+	},
+	"dependencies": {
+		"html-entities": "^2.3.3"
+	},
+	"gitHead": "715dd53d3b1064a9bcf616c1533921cad9e3b187"
+}