mirror of
https://github.com/iconify/collections-json.git
synced 2024-11-21 12:05:11 +00:00
feat: add esm support
This commit is contained in:
parent
ef8cd86b28
commit
f684a5661a
8
.eslintrc.json
Normal file
8
.eslintrc.json
Normal file
@ -0,0 +1,8 @@
|
||||
{
|
||||
"extends": "@antfu/eslint-config",
|
||||
"rules": {
|
||||
"@typescript-eslint/no-unused-vars": "off",
|
||||
"react/react-in-jsx-scope": "off",
|
||||
"react/no-unknown-property": "off"
|
||||
}
|
||||
}
|
6
.gitignore
vendored
6
.gitignore
vendored
@ -1,2 +1,4 @@
|
||||
.idea
|
||||
.DS_Store
|
||||
.idea/
|
||||
.DS_Store
|
||||
dist/
|
||||
node_modules/
|
||||
|
1
index.d.ts
vendored
Normal file
1
index.d.ts
vendored
Normal file
@ -0,0 +1 @@
|
||||
export * from './dist'
|
@ -1,49 +0,0 @@
|
||||
/**
|
||||
* This file is part of the iconify.design libraries.
|
||||
*
|
||||
* (c) Vjacheslav Trushkin <cyberalien@gmail.com>
|
||||
*
|
||||
* @license MIT
|
||||
*
|
||||
* For the full copyright and license information, please view the license.txt
|
||||
* file that is available in this file's directory.
|
||||
*/
|
||||
|
||||
"use strict";
|
||||
|
||||
const path = require('path');
|
||||
const fs = require('fs');
|
||||
const dir = path.dirname(__dirname);
|
||||
|
||||
module.exports = {
|
||||
/**
|
||||
* Get root directory of this package
|
||||
* (not really useful in Node.js because require can do it, but added anyway to match php code)
|
||||
*
|
||||
* @returns {string}
|
||||
*/
|
||||
rootDir: () => dir,
|
||||
|
||||
/**
|
||||
* Locate JSON file
|
||||
*
|
||||
* @param {string} name Collection name
|
||||
* @returns {string} Path to collection json file
|
||||
*/
|
||||
locate: name => dir + '/json/' + name + '.json',
|
||||
|
||||
/**
|
||||
* Get list of collections
|
||||
*
|
||||
* @return {object|null}
|
||||
*/
|
||||
collections: () => {
|
||||
try {
|
||||
let data = fs.readFileSync(dir + '/collections.json', 'utf8');
|
||||
data = JSON.parse(data);
|
||||
return data;
|
||||
} catch (err) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
};
|
399
lib/finder.ts
Normal file
399
lib/finder.ts
Normal file
@ -0,0 +1,399 @@
|
||||
/**
|
||||
* This file is part of the iconify.design libraries.
|
||||
*
|
||||
* (c) Vjacheslav Trushkin <cyberalien@gmail.com>
|
||||
*
|
||||
* @license MIT
|
||||
*
|
||||
* For the full copyright and license information, please view the license.txt
|
||||
* file that is available in this file's directory.
|
||||
*/
|
||||
import { promises as fs } from 'fs'
|
||||
import { fileURLToPath } from 'url'
|
||||
import { dirname, resolve } from 'upath'
|
||||
|
||||
/**
|
||||
* Icon dimensions.
|
||||
*
|
||||
* Used in:
|
||||
* icon (as is)
|
||||
* alias (overwrite icon's properties)
|
||||
* root of JSON file (default values)
|
||||
*/
|
||||
export interface IconifyDimensions {
|
||||
/**
|
||||
* Left position of viewBox.
|
||||
*
|
||||
* @default 0
|
||||
*/
|
||||
left?: number
|
||||
/**
|
||||
* Top position of viewBox.
|
||||
*
|
||||
* @default 0
|
||||
*/
|
||||
top?: number
|
||||
/**
|
||||
* Width of viewBox.
|
||||
*
|
||||
* @default 16
|
||||
*/
|
||||
width?: number
|
||||
/**
|
||||
* height of viewBox.
|
||||
*
|
||||
* @default 16
|
||||
*/
|
||||
height?: number
|
||||
}
|
||||
|
||||
/**
|
||||
* Icon transformations.
|
||||
*
|
||||
* Used in:
|
||||
* icon (as is)
|
||||
* alias (merged with icon's properties)
|
||||
* root of JSON file (default values)
|
||||
*/
|
||||
export interface IconifyTransformations {
|
||||
/**
|
||||
* rotation, values: 0 = 0deg, 1 = 90deg, 2 = 180deg, 3 = 270deg
|
||||
*
|
||||
* @default 0
|
||||
*/
|
||||
rotate?: 0 | 1 | 2 | 3
|
||||
/**
|
||||
* horizontal flip
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
hFlip?: boolean
|
||||
/**
|
||||
* vertical flip
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
vFlip?: boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Combination of dimensions and transformations.
|
||||
*/
|
||||
export interface IconifyOptional extends IconifyDimensions, IconifyTransformations {
|
||||
}
|
||||
|
||||
/**
|
||||
* Alias.
|
||||
*/
|
||||
export interface IconifyAlias extends IconifyOptional {
|
||||
/**
|
||||
* Parent icon index without prefix, required.
|
||||
*/
|
||||
parent: string
|
||||
|
||||
// IconifyOptional properties.
|
||||
// Alias should have only properties that it overrides.
|
||||
// Transformations are merged, not overridden. See IconifyTransformations comments.
|
||||
}
|
||||
|
||||
/**
|
||||
* Icon.
|
||||
*/
|
||||
export interface IconifyIcon extends IconifyOptional {
|
||||
/**
|
||||
* Icon body: <path d="..." />, required.
|
||||
*/
|
||||
body: string
|
||||
|
||||
// IconifyOptional properties.
|
||||
// If property is missing in JSON file, look in root object for default value.
|
||||
}
|
||||
|
||||
/**
|
||||
* Icon with optional parameters that are provided by API and affect only search
|
||||
*/
|
||||
interface APIIconAttributes {
|
||||
/**
|
||||
* True if icon is hidden.
|
||||
*
|
||||
* Used in icon sets to keep icons that no longer exist, but should still be accessible
|
||||
* from API, preventing websites from breaking when icon is removed by developer.
|
||||
*
|
||||
* @default false
|
||||
*/
|
||||
hidden?: boolean
|
||||
}
|
||||
|
||||
export interface ExtendedIconifyIcon extends IconifyIcon, APIIconAttributes {}
|
||||
export interface ExtendedIconifyAlias extends IconifyAlias, APIIconAttributes {}
|
||||
|
||||
/**
|
||||
* "icons" field of JSON file.
|
||||
*/
|
||||
export interface IconifyIcons {
|
||||
/**
|
||||
* Index is name of icon, without prefix. Value is ExtendedIconifyIcon object.
|
||||
*/
|
||||
[index: string]: ExtendedIconifyIcon
|
||||
}
|
||||
|
||||
/**
|
||||
* "aliases" field of JSON file.
|
||||
*/
|
||||
export interface IconifyAliases {
|
||||
/**
|
||||
* Index is name of icon, without prefix. Value is ExtendedIconifyAlias object.
|
||||
*/
|
||||
[index: string]: ExtendedIconifyAlias
|
||||
}
|
||||
|
||||
/**
|
||||
* Iconify collection info.
|
||||
*/
|
||||
export interface IconifyInfo {
|
||||
/**
|
||||
* Icon set name.
|
||||
*/
|
||||
name: string
|
||||
/**
|
||||
* Total number of icons.
|
||||
*/
|
||||
total?: number
|
||||
/**
|
||||
* Version string.
|
||||
*/
|
||||
version?: string
|
||||
/**
|
||||
* Author information.
|
||||
*/
|
||||
author: string | {
|
||||
/**
|
||||
* Author name.
|
||||
*/
|
||||
name: string
|
||||
/**
|
||||
* Link to author's website or icon set website.
|
||||
*/
|
||||
url?: string
|
||||
}
|
||||
/**
|
||||
* Link to author's website or icon set website.
|
||||
*/
|
||||
url?: string
|
||||
/**
|
||||
* License.
|
||||
*/
|
||||
license: string | {
|
||||
/**
|
||||
* Human readable license.
|
||||
*/
|
||||
title: string
|
||||
/**
|
||||
* SPDX license identifier.
|
||||
*/
|
||||
spdx?: string
|
||||
/**
|
||||
* License URL.
|
||||
*/
|
||||
url?: string
|
||||
}
|
||||
/**
|
||||
* License URL.
|
||||
*/
|
||||
licenseURL?: string
|
||||
/**
|
||||
* Array of icons that should be used for samples in icon sets list.
|
||||
*/
|
||||
samples: string[]
|
||||
/**
|
||||
* Icon grid: number or array of numbers.
|
||||
*/
|
||||
height?: number | number[]
|
||||
/**
|
||||
* Display height for samples: 16 - 24.
|
||||
*
|
||||
* @default 16
|
||||
*/
|
||||
displayHeight?: number
|
||||
/**
|
||||
* Category on Iconify collections list.
|
||||
*/
|
||||
category?: string
|
||||
/**
|
||||
* Palette status.
|
||||
*
|
||||
* True if icons have predefined color scheme, false if icons use currentColor.
|
||||
* Icon set should not mix icons with and without palette to simplify search.
|
||||
*/
|
||||
palette: string | boolean
|
||||
}
|
||||
|
||||
/**
|
||||
* Optional themes, old format.
|
||||
*
|
||||
* Deprecated because format is unnecessary complicated. Key is meaningless, suffixes and prefixes are mixed together.
|
||||
*/
|
||||
export interface LegacyIconifyThemes {
|
||||
/**
|
||||
* Key is unique string.
|
||||
*/
|
||||
[index: string]: {
|
||||
/**
|
||||
* Theme title.
|
||||
*/
|
||||
title: string
|
||||
/**
|
||||
* Icon prefix or suffix, including dash.
|
||||
*
|
||||
* All icons that start with prefix and end with suffix belong to theme.
|
||||
*
|
||||
* Example: 'baseline-'
|
||||
*/
|
||||
prefix?: string
|
||||
/**
|
||||
* Icon suffix or suffix, including dash.
|
||||
*
|
||||
* All icons that start with prefix and end with suffix belong to theme.
|
||||
*
|
||||
* Example: '-filled'
|
||||
*/
|
||||
suffix?: string
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Characters used in font.
|
||||
*/
|
||||
export interface IconifyChars {
|
||||
/**
|
||||
* Index is character, such as "f000".
|
||||
*
|
||||
* Value is icon name.
|
||||
*/
|
||||
[index: string]: string
|
||||
}
|
||||
|
||||
/**
|
||||
* Icon categories
|
||||
*/
|
||||
export interface IconifyCategories {
|
||||
/**
|
||||
* Index is category title, such as "Weather".
|
||||
*
|
||||
* Value is array of icons that belong to that category.
|
||||
* Each icon can belong to multiple categories or no categories.
|
||||
*/
|
||||
[index: string]: string[]
|
||||
}
|
||||
|
||||
/**
|
||||
* Meta data stored in JSON file, used for browsing icon set.
|
||||
*/
|
||||
export interface IconifyMetaData {
|
||||
/**
|
||||
* Icon set information block.
|
||||
*
|
||||
* Used for public icon sets, can be skipped for private icon sets.
|
||||
*/
|
||||
info?: IconifyInfo
|
||||
/**
|
||||
* Characters used in font.
|
||||
*
|
||||
* Used for searching by character for icon sets imported from font, exporting icon set to font.
|
||||
*/
|
||||
chars?: IconifyChars
|
||||
/**
|
||||
* Categories.
|
||||
*
|
||||
* Used for filtering icons.
|
||||
*/
|
||||
categories?: IconifyCategories
|
||||
/**
|
||||
* Optional themes (old format).
|
||||
*/
|
||||
themes?: LegacyIconifyThemes
|
||||
/**
|
||||
* Optional themes prefixes (new format).
|
||||
*
|
||||
* Key is prefix, value is title.
|
||||
*/
|
||||
prefixes?: Record<string, string>
|
||||
/**
|
||||
* Optional themes suffixes (new format).
|
||||
*
|
||||
* Key is suffix, value is title.
|
||||
*/
|
||||
suffixes?: Record<string, string>
|
||||
}
|
||||
|
||||
/**
|
||||
* JSON structure.
|
||||
*
|
||||
* All optional values can exist in root of JSON file, used as defaults.
|
||||
*/
|
||||
export interface IconifyJSON extends IconifyOptional, IconifyMetaData {
|
||||
/**
|
||||
* Prefix for icons in JSON file, required.
|
||||
*/
|
||||
prefix: string
|
||||
/**
|
||||
* API provider, optional.
|
||||
*/
|
||||
provider?: string
|
||||
/**
|
||||
* List of icons, required.
|
||||
*/
|
||||
icons: IconifyIcons
|
||||
/**
|
||||
* Optional aliases.
|
||||
*/
|
||||
aliases?: IconifyAliases
|
||||
/**
|
||||
* Optional list of missing icons.
|
||||
*
|
||||
* Returned by Iconify API when querying for icons that do not exist.
|
||||
*/
|
||||
not_found?: string[]
|
||||
// IconifyOptional properties that are used as default values for icons when icon is missing value.
|
||||
// If property exists in both icon and root, use value from icon.
|
||||
// This is used to reduce duplication.
|
||||
}
|
||||
|
||||
const _dirname = typeof __dirname !== 'undefined' ? __dirname : dirname(fileURLToPath(import.meta.url))
|
||||
|
||||
const dir = resolve(_dirname, '..')
|
||||
|
||||
/**
|
||||
* Get root directory of this package
|
||||
* (not really useful in Node.js because require can do it, but added anyway to match php code)
|
||||
*
|
||||
* @returns {string}
|
||||
*/
|
||||
export const rootDir = () => dir
|
||||
|
||||
/**
|
||||
* Locate JSON file
|
||||
*
|
||||
* @param {string} name Collection name
|
||||
* @returns {string} Path to collection json file
|
||||
*/
|
||||
export const locate = (name: string) => `${dir}/json/${name}.json`
|
||||
|
||||
/**
|
||||
* Get a collection.
|
||||
*
|
||||
* @param {string} name The name of the collection
|
||||
* @return {Promise<IconifyJSON>}
|
||||
*/
|
||||
export const collection = async(name: string): Promise<IconifyJSON> => {
|
||||
return JSON.parse(await fs.readFile(locate(name), 'utf8'))
|
||||
}
|
||||
|
||||
/**
|
||||
* Get list of collections info.
|
||||
*
|
||||
* @return {Promise<IconifyMetaData[]>}
|
||||
*/
|
||||
export const collections = async(): Promise<IconifyMetaData[]> => {
|
||||
return JSON.parse(await fs.readFile(`${dir}/collections.json`, 'utf8'))
|
||||
}
|
10
lib/test.ts
Normal file
10
lib/test.ts
Normal file
@ -0,0 +1,10 @@
|
||||
import { collection, locate } from './finder'
|
||||
|
||||
const test = async(): Promise<void> => {
|
||||
const fa = locate('fa')
|
||||
console.log(fa)
|
||||
const faLib = await collection('fa')
|
||||
console.log(faLib)
|
||||
}
|
||||
|
||||
test()
|
36
package.json
36
package.json
@ -3,11 +3,39 @@
|
||||
"description": "Iconify icons collection in JSON format",
|
||||
"license": "MIT",
|
||||
"version": "1.1.401",
|
||||
"homepage": "https://iconify.design/icon-sets/",
|
||||
"main": "lib/finder.js",
|
||||
"bugs": "https://github.com/iconify/collections-json/issues",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+ssh://git@github.com/iconify/collections-json.git"
|
||||
},
|
||||
"files": [
|
||||
"dist",
|
||||
"json",
|
||||
"lib",
|
||||
"collections.json",
|
||||
"collections.md",
|
||||
"composer.md",
|
||||
"index.d.ts",
|
||||
"readme.md"
|
||||
],
|
||||
"main": "dist/finder.js",
|
||||
"module": "dist/finder.mjs",
|
||||
"types": "index.d.ts",
|
||||
"homepage": "https://iconify.design/icon-sets/",
|
||||
"bugs": "https://github.com/iconify/collections-json/issues",
|
||||
"scripts": {
|
||||
"build": "rimraf dist && tsup lib/finder.ts --format cjs,esm --dts",
|
||||
"test": "esno lib/test.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"upath": "^2.0.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@antfu/eslint-config": "^0.8.2",
|
||||
"@types/node": "^16.9.1",
|
||||
"@typescript-eslint/eslint-plugin": "^4.31.0",
|
||||
"eslint": "^7.32.0",
|
||||
"esno": "^0.9.1",
|
||||
"tsup": "^4.14.0",
|
||||
"typescript": "^4.4.3"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
20
tsconfig.json
Normal file
20
tsconfig.json
Normal file
@ -0,0 +1,20 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"baseUrl": ".",
|
||||
"module": "ESNext",
|
||||
"target": "es2017",
|
||||
"lib": ["ESNext", "DOM"],
|
||||
"esModuleInterop": true,
|
||||
"strict": true,
|
||||
"strictNullChecks": true,
|
||||
"moduleResolution": "Node",
|
||||
"resolveJsonModule": true,
|
||||
"skipLibCheck": true,
|
||||
"jsx": "preserve"
|
||||
},
|
||||
"exclude": [
|
||||
"**/dist",
|
||||
"**/node_modules",
|
||||
"**/test"
|
||||
]
|
||||
}
|
Loading…
Reference in New Issue
Block a user