@signozhq/icons 0.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/LICENSE +9 -0
  2. package/README.md +73 -0
  3. package/package.json +78 -0
package/LICENSE ADDED
@@ -0,0 +1,9 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 SigNoz
4
+
5
+ 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:
6
+
7
+ 1. The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
8
+
9
+ 2. 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 ADDED
@@ -0,0 +1,73 @@
1
+ # @signoz/icons
2
+
3
+ ## Description
4
+
5
+ `@signoz/icons` is a collection of SVG-based React icon components. This package provides a set of customizable icons that can be easily integrated into your React projects.
6
+
7
+ ## Features
8
+
9
+ - SVG-based icons for high-quality rendering
10
+ - Customizable via React props
11
+ - Easy integration with React projects
12
+
13
+ ## Installation
14
+
15
+ To install the package, use npm:
16
+
17
+ ```bash
18
+ npm install @signoz/icons
19
+ ```
20
+
21
+ ## Usage
22
+
23
+ To use an icon in your project, import it from the package and include it in your component:
24
+
25
+ ```jsx
26
+ import { IconName } from '@signoz/icons';
27
+
28
+ const MyComponent = () => (
29
+ <IconName />
30
+ );
31
+ ```
32
+
33
+ Replace `IconName` with the actual name of the icon you want to use.
34
+
35
+ ## Scripts
36
+
37
+ The following scripts are available in the package:
38
+
39
+ - `prebuild`: Cleans the `src` and `dist` directories using `rimraf`.
40
+ - `build`: Runs the `svgr` script and then builds the project using `rollup`.
41
+ - `svgr`: Converts SVG files to React components with specific options.
42
+
43
+ To run these scripts, use npm:
44
+
45
+ ```bash
46
+ npm run prebuild
47
+ npm run build
48
+ npm run svgr
49
+ ```
50
+
51
+ ## Development
52
+
53
+ ### Prerequisites
54
+
55
+ Make sure you have the following installed:
56
+
57
+ - Node.js
58
+ - npm
59
+
60
+ ### Building the Project
61
+
62
+ To build the project, run:
63
+
64
+ ```bash
65
+ npm run build
66
+ ```
67
+
68
+ This will generate the `dist` directory with the compiled files.
69
+
70
+ ### Contributing
71
+
72
+ We welcome contributions to this package. If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.
73
+
package/package.json ADDED
@@ -0,0 +1,78 @@
1
+ {
2
+ "name": "@signozhq/icons",
3
+ "author": "SigNoz",
4
+ "version": "0.0.0",
5
+ "description": "SVG-based React icon components",
6
+ "keywords": [
7
+ "React",
8
+ "SVG",
9
+ "Icons"
10
+ ],
11
+ "module": "dist/index.esm.js",
12
+ "types": "dist/types/index.d.ts",
13
+ "files": [
14
+ "dist"
15
+ ],
16
+ "scripts": {
17
+ "prebuild": "pnpm run precheck",
18
+ "precheck": "pnpm run clean && pnpm run lint ",
19
+ "clean": "rimraf src && rimraf dist",
20
+ "build": "pnpm run svgr && rollup -c",
21
+ "svgr": "svgr --typescript --replace-attr-values '#1D1D1D=currentColor' --template ./svgr-template.js -d src -- assets",
22
+ "lint": "eslint .",
23
+ "type-check": "tsc --noEmit",
24
+ "commitlint": "commitlint --edit",
25
+ "format": "prettier --write .",
26
+ "format:check": "prettier --check .",
27
+ "changeset": "changeset",
28
+ "version": "changeset version",
29
+ "release": "pnpm run build && changeset publish"
30
+ },
31
+ "license": "MIT",
32
+ "devDependencies": {
33
+ "@changesets/cli": "^2.27.8",
34
+ "@babel/plugin-transform-runtime": "^7.22.5",
35
+ "@babel/preset-env": "^7.16.4",
36
+ "@babel/preset-react": "^7.16.0",
37
+ "@babel/traverse": "^7.25.6",
38
+ "@rollup/plugin-babel": "^5.3.0",
39
+ "@rollup/plugin-typescript": "^12.1.2",
40
+ "@svgr/cli": "^6.1.2",
41
+ "@types/react": "^19.0.10",
42
+ "@typescript-eslint/eslint-plugin": "^5.59.11",
43
+ "@typescript-eslint/parser": "^5.59.11",
44
+ "eslint": "^8.42.0",
45
+ "eslint-config-prettier": "^10.0.1",
46
+ "eslint-import-resolver-node": "^0.3.9",
47
+ "eslint-plugin-import": "^2.31.0",
48
+ "eslint-plugin-react": "^7.37.4",
49
+ "husky": "^8.0.3",
50
+ "lint-staged": "^13.2.2",
51
+ "prettier": "^2.8.8",
52
+ "react": "^19.0.0",
53
+ "rimraf": "^3.0.2",
54
+ "rollup": "^2.61.1",
55
+ "rollup-plugin-filesize": "^10.0.0",
56
+ "rollup-plugin-svgo": "^2.0.0",
57
+ "rollup-plugin-terser": "^7.0.2",
58
+ "typescript": "^5.1.3",
59
+ "tslib": "^2.6.2"
60
+ },
61
+ "dependencies": {
62
+ "@babel/runtime": "^7.22.5",
63
+ "@commitlint/cli": "^17.6.7",
64
+ "@commitlint/config-conventional": "^17.6.7"
65
+ },
66
+ "lint-staged": {
67
+ "*.{js,jsx,ts,tsx}": [
68
+ "prettier --write",
69
+ "eslint --fix"
70
+ ]
71
+ },
72
+ "eslintIgnore": [
73
+ "dist/**",
74
+ "src/**",
75
+ "assets/**",
76
+ "*.svg"
77
+ ]
78
+ }