profinansy-ui-lib 2.0.39 → 2.0.41

package/package.json

@@ -1,63 +1,65 @@
-{
-  "name": "profinansy-ui-lib",
-  "version": "2.0.39",
-  "main": "./dist/index.js",
-  "license": "MIT",
-  "devDependencies": {
-    "@babel/preset-env": "^7.22.5",
-    "@babel/preset-react": "^7.22.5",
-    "@babel/preset-typescript": "^7.22.5",
-    "@storybook/addon-essentials": "7.0.24",
-    "@storybook/addon-interactions": "7.0.24",
-    "@storybook/addon-links": "7.0.24",
-    "@storybook/blocks": "7.0.24",
-    "@storybook/react": "7.0.24",
-    "@storybook/react-webpack5": "7.0.24",
-    "@storybook/testing-library": "0.0.14-next.2",
-    "@svgr/webpack": "^8.1.0",
-    "@types/file-loader": "^5.0.1",
-    "@types/react": "^18.0.27",
-    "@types/styled-components": "^5.1.26",
-    "@typescript-eslint/eslint-plugin": "^6.2.0",
-    "@typescript-eslint/parser": "^6.2.0",
-    "classnames": "^2.3.2",
-    "css-loader": "^6.7.3",
-    "date-fns": "^2.30.0",
-    "eslint": "^8.45.0",
-    "eslint-plugin-react": "^7.33.0",
-    "file-loader": "^6.2.0",
-    "husky": "^8.0.3",
-    "prettier": "2.8.8",
-    "prop-types": "15.8.1",
-    "react": "18.2.0",
-    "react-dom": "18.2.0",
-    "sass": "^1.57.1",
-    "sass-loader": "^13.2.0",
-    "storybook": "7.0.24",
-    "style-loader": "^3.3.1",
-    "styled-components": "^5.3.6",
-    "ts-loader": "^9.4.2",
-    "tsconfig-paths-webpack-plugin": "^4.1.0",
-    "typescript": "^4.9.4",
-    "webpack": "^5.75.0",
-    "webpack-cli": "^5.0.1"
-  },
-  "scripts": {
-    "build": "webpack",
-    "pub": "webpack && npm version patch && npm publish",
-    "lint": "eslint .",
-    "lint:fix": "eslint --fix",
-    "types": "tsc",
-    "storybook": "storybook dev -p 6006",
-    "build-storybook": "storybook build",
-    "prepare": "husky install",
-    "checks:pre-commit": "yarn lint"
-  },
-  "peerDependencies": {
-    "react": "^17",
-    "styled-components": "^5.3.6"
-  },
-  "files": [
-    "dist"
-  ]
-}
+{
+  "name": "profinansy-ui-lib",
+  "version": "2.0.41",
+  "main": "./dist/index.js",
+  "license": "MIT",
+  "devDependencies": {
+    "@babel/preset-env": "^7.22.5",
+    "@babel/preset-react": "^7.22.5",
+    "@babel/preset-typescript": "^7.22.5",
+    "@storybook/addon-essentials": "7.0.24",
+    "@storybook/addon-interactions": "7.0.24",
+    "@storybook/addon-links": "7.0.24",
+    "@storybook/blocks": "7.0.24",
+    "@storybook/react": "7.0.24",
+    "@storybook/react-webpack5": "7.0.24",
+    "@storybook/testing-library": "0.0.14-next.2",
+    "@svgr/webpack": "^8.1.0",
+    "@types/file-loader": "^5.0.1",
+    "@types/react": "^18.0.27",
+    "@types/styled-components": "^5.1.26",
+    "@typescript-eslint/eslint-plugin": "^6.2.0",
+    "@typescript-eslint/parser": "^6.2.0",
+    "classnames": "^2.3.2",
+    "css-loader": "^6.7.3",
+    "date-fns": "^2.30.0",
+    "eslint": "^8.45.0",
+    "eslint-plugin-react": "^7.33.0",
+    "file-loader": "^6.2.0",
+    "husky": "^8.0.3",
+    "prettier": "2.8.8",
+    "prop-types": "15.8.1",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
+    "sass": "^1.57.1",
+    "sass-loader": "^13.2.0",
+    "storybook": "7.0.24",
+    "style-loader": "^3.3.1",
+    "styled-components": "^5.3.6",
+    "ts-loader": "^9.4.2",
+    "tsconfig-paths-webpack-plugin": "^4.1.0",
+    "typescript": "^4.9.4",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^5.0.1"
+  },
+  "scripts": {
+    "build": "webpack",
+    "pub": "webpack && npm version patch && npm publish",
+    "lint": "eslint .",
+    "lint:fix": "eslint --fix",
+    "types": "tsc",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build",
+    "icons:story": "node .\\generateIconsStories.ts",
+    "prepare": "husky install",
+    "checks:pre-commit": "yarn lint"
+  },
+  "peerDependencies": {
+    "react": "^17",
+    "styled-components": "^5.3.6"
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {}
+}

package/readme.md

@@ -1,10 +1,20 @@
-# Флоу работы
-1. Создать ветку от master
-2. Сделать изменения, обновить версию в package.json, выполнить команду yarn build, запушить в гитлаб и открыть МР в мастер(прикрепляете ссылку на задачу в МР и кидаете его в группу в телеге)
-3. Ревьювер посмотрит на МР, если это апрув, примет МР в main, и выполнит у себя локально команду npm publish
-
-
-# Как смотреть изменения
-1. Надо расшарить локально репу общих компонентов, для этого в терминале в корневой директории проекта **profinansy-react-components** запустить команду **yarn link**
-2. В своем проекте, в котором используется эта репа(profinansy, к примеру),надо выполнить команду **yarn remove profinansy-ui-lib**, затем **yarn link profinansy-ui-lib**. Для применения изменений выполняйте команду **yarn build** в репозитории **profinansy-react-components**. Возможно то, что typescript будет кидать ошибки JSX типа "**cannot be used as a JSX component**", пока вы не отвяжете локальную привязку
-3. После завершения работы над компонентами, надо отвязать привязку: **yarn unlink profinansy-ui-lib**, затем **yarn add --force profinansy-ui-lib**
+# Флоу работы
+1. Создать ветку от master
+2. Сделать изменения, обновить версию в package.json, выполнить команду yarn build, запушить в гитлаб и открыть МР в мастер(прикрепляете ссылку на задачу в МР и кидаете его в группу в телеге)
+3. Ревьювер посмотрит на МР, если это апрув, примет МР в main, и выполнит у себя локально команду npm publish
+
+
+# Как смотреть изменения
+1. Надо расшарить локально репу общих компонентов, для этого в терминале в корневой директории проекта **profinansy-react-components** запустить команду **yarn link**
+2. В своем проекте, в котором используется эта репа(profinansy, к примеру),надо выполнить команду **yarn remove profinansy-ui-lib**, затем **yarn link profinansy-ui-lib**. Для применения изменений выполняйте команду **yarn build** в репозитории **profinansy-react-components**. Возможно то, что typescript будет кидать ошибки JSX типа "**cannot be used as a JSX component**", пока вы не отвяжете локальную привязку
+3. После завершения работы над компонентами, надо отвязать привязку: **yarn unlink profinansy-ui-lib**, затем **yarn add --force profinansy-ui-lib**
+
+## Как работать с иконками
+
+Все иконки кладем в папку icons в формате svg. Подключать в компонент иконки
+можно напрямую через import. Они сгенерируются в компоненты автоматически
+через `svgr`. 
+Все иконки, используемые на проекте, отображаются в сторибуке.
+После того, как вы добавили новые иконки в проект, запустите скрипт
+``yarn icons:story``. Он автоматически сгенерирует новый `.stories` файл
+и добавит все ваши новые иконки.