@ohos-ports/get-system-fonts 0.0.0-stage → 2.0.2-beta.0

package/CHANGELOG.md

@@ -0,0 +1,25 @@
+## [2.0.2](https://github.com/princjef/get-system-fonts/compare/v2.0.1...v2.0.2) (2020-06-12)
+
+
+### Bug Fixes
+
+* **no:** add option to regexp ignoreCase ([#8](https://github.com/princjef/get-system-fonts/issues/8)) ([0b3271f](https://github.com/princjef/get-system-fonts/commit/0b3271f))
+
+## [2.0.1](https://github.com/princjef/get-system-fonts/compare/v2.0.0...v2.0.1) (2019-04-23)
+
+
+### Bug Fixes
+
+* **windows:** include fonts installed to local app data on windows ([#4](https://github.com/princjef/get-system-fonts/issues/4)) ([95183eb](https://github.com/princjef/get-system-fonts/commit/95183eb)), closes [#3](https://github.com/princjef/get-system-fonts/issues/3)
+
+# [2.0.0](https://github.com/princjef/get-system-fonts/compare/v1.0.0...v2.0.0) (2018-07-30)
+
+
+### Performance Improvements
+
+* remove fast-glob dependency to reduce install size ([f033af5](https://github.com/princjef/get-system-fonts/commit/f033af5))
+
+
+### BREAKING CHANGES
+
+* dropped support for Node 6 and 7

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Jeffrey Principe
+
+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

@@ -1,3 +1,44 @@
-# Temporary Holding Version
+# get-system-fonts
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[![Travis CI build status](https://travis-ci.org/princjef/get-system-fonts.svg?branch=master)](https://travis-ci.org/princjef/get-system-fonts)
+[![codecov](https://codecov.io/gh/princjef/get-system-fonts/branch/master/graph/badge.svg)](https://codecov.io/gh/princjef/get-system-fonts)
+[![npm version](https://img.shields.io/npm/v/get-system-fonts.svg)](https://npmjs.org/package/get-system-fonts)
+
+List full paths to all of the system fonts present.
+
+```
+npm install get-system-fonts
+```
+
+## Usage
+
+```js
+const getSystemFonts = require('get-system-fonts');
+
+// In an async function...
+const files = await getSystemFonts(); // ['/Library/Fonts/Georgia.ttf', ...]
+```
+
+## API
+
+### `getSystemFonts([options]): Promise<string[]>`
+
+Lists absolute paths to all system fonts
+
+*NOTE: If you're using Typescript, `getSystemFonts()` is available as the 
+default export.*
+
+**Params**
+
+ * `options` [*object*] - Options for configuring retrieval
+    * `additionalFolders` [*string[]*] - Paths to additional folders to
+      recursively scan for font files. Absolute paths are recommended. Default:
+      `[]`
+    * `extensions` [*string[]*] - List of file extensions to treat as font
+      files. Default: `['ttf', 'otf', 'ttc', 'woff', 'woff2']`
+
+## Contributing
+
+Want to contribute to the project? Go check out the [Contribution 
+Guide](CONTRIBUTING.md) for instructions to set up your development 
+environment, open an issue and create a pull request.

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+export interface Options {
+    /**
+     * Additional folders to search for fonts. Default: []
+     */
+    additionalFolders?: string[];
+    /**
+     * File extensions to search for. Default: ['ttf', 'otf', 'ttc', 'woff', 'woff2']
+     */
+    extensions?: string[];
+}
+/**
+ * List absolute paths to all installed system fonts present.
+ *
+ * @param options Configuration options
+ */
+declare function getSystemFonts(options?: Options): Promise<string[]>;
+export default getSystemFonts;

package/dist/index.js

@@ -0,0 +1,88 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
+const os = require("os");
+const recursiveWalk_1 = require("./recursiveWalk");
+const directories = {
+    win32: () => {
+        const globalDir = path.join(process.env.WINDIR || 'C:\\Windows', 'Fonts');
+        const appDataDir = 'Microsoft\\Windows\\Fonts';
+        let localDir;
+        if (process.env.LOCALAPPDATA) {
+            localDir = path.join(process.env.LOCALAPPDATA, appDataDir);
+        }
+        else if (process.env.APPDATA) {
+            localDir = path.join(process.env.APPDATA, 'Local', appDataDir);
+        }
+        else if (process.env.USERPROFILE) {
+            localDir = path.join(process.env.USERPROFILE, 'AppData', 'Local', appDataDir);
+        }
+        if (localDir) {
+            return [globalDir, localDir];
+        }
+        else {
+            return [globalDir];
+        }
+    },
+    darwin: () => {
+        const home = os.homedir();
+        const userFolders = home
+            ? [path.join(home, '/Library/Fonts')]
+            : [];
+        return [
+            ...userFolders,
+            '/Library/Fonts',
+            '/Network/Library/Fonts',
+            '/System/Library/Fonts',
+            '/System Folder/Fonts'
+        ];
+    },
+    linux: () => {
+        const home = os.homedir();
+        const userFolders = home
+            ? [
+                path.join(home, '.fonts'),
+                path.join(home, '.local/share/fonts')
+            ]
+            : [];
+        return [
+            // TODO: use fontconfig to find the folder locations
+            '/usr/share/fonts',
+            '/usr/local/share/fonts',
+            ...userFolders
+        ];
+    },
+    openharmony: () => {
+        const home = os.homedir();
+        const userFolders = home
+            ? [
+                path.join(home, '.fonts'),
+                path.join(home, '.local/share/fonts')
+            ]
+            : [];
+        return [
+            '/system/fonts',
+            '/usr/share/fonts',
+            '/usr/local/share/fonts',
+            ...userFolders
+        ];
+    }
+};
+/**
+ * List absolute paths to all installed system fonts present.
+ *
+ * @param options Configuration options
+ */
+function getSystemFonts(options) {
+    const opts = Object.assign({ extensions: ['ttf', 'otf', 'ttc', 'woff', 'woff2'], additionalFolders: [] }, options);
+    const platform = os.platform();
+    const getDirs = directories[platform];
+    if (!getDirs) {
+        throw new Error(`Unsupported platform: ${platform}`);
+    }
+    const dirs = getDirs();
+    return recursiveWalk_1.default([...dirs, ...opts.additionalFolders], opts.extensions);
+}
+module.exports = Object.assign(getSystemFonts, { default: getSystemFonts });
+exports.default = getSystemFonts;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;AAAA,6BAA6B;AAC7B,yBAAyB;AAEzB,mDAA4C;AAE5C,MAAM,WAAW,GAAiD;IAC9D,KAAK,EAAE,GAAG,EAAE;QACR,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,IAAI,aAAa,EAAE,OAAO,CAAC,CAAC;QAE1E,MAAM,UAAU,GAAG,2BAA2B,CAAC;QAE/C,IAAI,QAA4B,CAAC;QACjC,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE;YAC1B,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;SAC9D;aAAM,IAAI,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE;YAC5B,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;SAClE;aAAM,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE;YAChC,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,SAAS,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;SACjF;QAED,IAAI,QAAQ,EAAE;YACV,OAAO,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;SAChC;aAAM;YACH,OAAO,CAAC,SAAS,CAAC,CAAC;SACtB;IACL,CAAC;IACD,MAAM,EAAE,GAAG,EAAE;QACT,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,IAAI;YACpB,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,gBAAgB,CAAC,CAAC;YACrC,CAAC,CAAC,EAAE,CAAC;QACT,OAAO;YACH,GAAG,WAAW;YACd,gBAAgB;YAChB,wBAAwB;YACxB,uBAAuB;YACvB,sBAAsB;SACzB,CAAC;IACN,CAAC;IACD,KAAK,EAAE,GAAG,EAAE;QACR,MAAM,IAAI,GAAG,EAAE,CAAC,OAAO,EAAE,CAAC;QAC1B,MAAM,WAAW,GAAG,IAAI;YACpB,CAAC,CAAC;gBACE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC;gBACzB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,oBAAoB,CAAC;aACxC;YACD,CAAC,CAAC,EAAE,CAAC;QACT,OAAO;YACH,oDAAoD;YACpD,kBAAkB;YAClB,wBAAwB;YACxB,GAAG,WAAW;SACjB,CAAC;IACN,CAAC;CACJ,CAAC;AAcF;;;;GAIG;AACH,SAAS,cAAc,CAAC,OAAiB;IACrC,MAAM,IAAI,mBACN,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAClD,iBAAiB,EAAE,EAAE,IAClB,OAAO,CACb,CAAC;IAEF,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC;IAE/B,MAAM,OAAO,GAAG,WAAW,CAAC,QAAQ,CAAC,CAAC;IACtC,IAAI,CAAC,OAAO,EAAE;QACV,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,EAAE,CAAC,CAAC;KACxD;IAED,MAAM,IAAI,GAAG,OAAO,EAAE,CAAC;IAEvB,OAAO,uBAAa,CAAC,CAAC,GAAG,IAAI,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;AAChF,CAAC;AAED,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,cAAc,EAAE,EAAE,OAAO,EAAE,cAAc,EAAE,CAAC,CAAC;AAC5E,kBAAe,cAAc,CAAC"}

package/dist/index.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/recursiveWalk.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Recursively scans the list of directories for files with one of the provided
+ * extensions.
+ *
+ * @param baseDirs Directories to search for files
+ * @param extensions List of valid extensions that files may have
+ */
+export default function recursiveWalk(baseDirs: string[], extensions: string[]): Promise<string[]>;

package/dist/recursiveWalk.js

@@ -0,0 +1,67 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const fs = require("fs");
+const util = require("util");
+const path = require("path");
+const readdirAsync = util.promisify(fs.readdir);
+const statAsync = util.promisify(fs.stat);
+/**
+ * Recursively scans the list of directories for files with one of the provided
+ * extensions.
+ *
+ * @param baseDirs Directories to search for files
+ * @param extensions List of valid extensions that files may have
+ */
+async function recursiveWalk(baseDirs, extensions) {
+    // We put the results in a set to ensure there are no duplicates
+    const results = new Set();
+    await Promise.all(baseDirs.map(async (baseDir) => {
+        const files = await recursiveWalkInternal(path.resolve(baseDir), new RegExp(`\\.${extensions.map(ext => `(?:${ext})`).join('|')}$`, 'i'));
+        for (const file of files) {
+            results.add(file);
+        }
+    }));
+    return [...results];
+}
+exports.default = recursiveWalk;
+/**
+ * Recursively walk the filesystem to find files with the proper extensions.
+ *
+ * @param baseDir The fully resolved starting directory (absolute path)
+ * @param extensionRegex Regular expression to verify the file extension
+ * @param maxDepth The maximum number of recursive calls to make before stopping
+ */
+async function recursiveWalkInternal(baseDir, extensionRegex, maxDepth = 10) {
+    if (maxDepth <= 0) {
+        return [];
+    }
+    let entries;
+    try {
+        entries = await readdirAsync(baseDir);
+    }
+    catch (_a) {
+        return [];
+    }
+    // We collect the results up in this array as we find them rather than
+    // mapping/reducing the data to avoid the cost of creating and concatenating
+    // intermediate arrays.
+    const results = [];
+    await Promise.all(entries.map(async (entry) => {
+        const entryPath = path.join(baseDir, entry);
+        let stats;
+        try {
+            stats = await statAsync(entryPath);
+        }
+        catch (_a) {
+            return;
+        }
+        if (stats.isFile() && extensionRegex.test(entryPath)) {
+            results.push(entryPath);
+        }
+        else if (stats.isDirectory()) {
+            results.push(...await recursiveWalkInternal(entryPath, extensionRegex, maxDepth - 1));
+        }
+    }));
+    return results;
+}
+//# sourceMappingURL=recursiveWalk.js.map

package/dist/recursiveWalk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recursiveWalk.js","sourceRoot":"","sources":["../src/recursiveWalk.ts"],"names":[],"mappings":";;AAAA,yBAAyB;AACzB,6BAA6B;AAC7B,6BAA6B;AAE7B,MAAM,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC;AAChD,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;AAE1C;;;;;;GAMG;AACY,KAAK,UAAU,aAAa,CAAC,QAAkB,EAAE,UAAoB;IAChF,gEAAgE;IAChE,MAAM,OAAO,GAAgB,IAAI,GAAG,EAAE,CAAC;IAEvC,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAC,OAAO,EAAC,EAAE;QAC3C,MAAM,KAAK,GAAG,MAAM,qBAAqB,CACrC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,EACrB,IAAI,MAAM,CAAC,MAAM,UAAU,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,CAC1E,CAAC;QAEF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACtB,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;SACrB;IACL,CAAC,CAAC,CAAC,CAAC;IAEJ,OAAO,CAAC,GAAG,OAAO,CAAC,CAAC;AACxB,CAAC;AAhBD,gCAgBC;AAED;;;;;;GAMG;AACH,KAAK,UAAU,qBAAqB,CAAC,OAAe,EAAE,cAAsB,EAAE,WAAmB,EAAE;IAC/F,IAAI,QAAQ,IAAI,CAAC,EAAE;QACf,OAAO,EAAE,CAAC;KACb;IAED,IAAI,OAAiB,CAAC;IACtB,IAAI;QACA,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;KACzC;IAAC,WAAM;QACJ,OAAO,EAAE,CAAC;KACb;IAED,sEAAsE;IACtE,4EAA4E;IAC5E,uBAAuB;IACvB,MAAM,OAAO,GAAa,EAAE,CAAC;IAE7B,MAAM,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,EAAC,KAAK,EAAC,EAAE;QACxC,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5C,IAAI,KAAe,CAAC;QACpB,IAAI;YACA,KAAK,GAAG,MAAM,SAAS,CAAC,SAAS,CAAC,CAAC;SACtC;QAAC,WAAM;YACJ,OAAO;SACV;QAED,IAAI,KAAK,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;YAClD,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;SAC3B;aAAM,IAAI,KAAK,CAAC,WAAW,EAAE,EAAE;YAC5B,OAAO,CAAC,IAAI,CAAC,GAAG,MAAM,qBAAqB,CACvC,SAAS,EACT,cAAc,EACd,QAAQ,GAAG,CAAC,CACf,CAAC,CAAC;SACN;IACL,CAAC,CAAC,CAAC,CAAC;IAEJ,OAAO,OAAO,CAAC;AACnB,CAAC"}

package/dist/recursiveWalk.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@ohos-ports/get-system-fonts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "2.0.2-beta.0",
+  "description": "List full paths to all system fonts",
+  "homepage": "https://github.com/princjef/get-system-fonts#readme",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ohos-ports/ohos-ports.git",
+    "directory": "ports/get-system-fonts/2.0.2"
+  },
+  "bugs": {
+    "url": "https://github.com/ohos-ports/ohos-ports/issues"
+  },
+  "engines": {
+    "node": ">8.0.0"
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "keywords": [
+    "font",
+    "system",
+    "ttf",
+    "otf",
+    "file"
+  ],
+  "author": "Jeff Principe <princjef@gmail.com>",
+  "license": "MIT",
+  "dependencies": {},
+  "files": [
+    "dist",
+    "LICENSE.md",
+    "README.md",
+    "CHANGELOG.md"
+  ]
+}