@benefex/icons 0.7.0 → 0.8.0

package/README.md

@@ -8,29 +8,31 @@ SVGs are automatically converted to TSX using [svgr](https://react-svgr.com/)
 - Make sure it has `fill="currentColor` or `stroke="currentColor"`
 - Make sure it has a viewBox (width, height will be removed)
 
-### Publishing
-
-All version deployments are handled by circleCI. To begin developing a new version you will need to create a branch.
-
-Use [`npm version`](https://docs.npmjs.com/cli/version) with the feature branch checked out to create a new version commit. This will automatically update the version number in `package.json` and other relevant files. Code is linted and tested before a version is created.
-
-Use [semantic versioning](https://semver.org) where possible:
-
+### Versioning
+Use [semantic versioning](https://semver.org):
 - `major` version when you make incompatible API changes
 - `minor` version when you add functionality in a backwards-compatible manner
 - `patch` version when you make backwards-compatible bug fixes
 
-```bash
-git checkout -b branchname
-npm version patch # patch/minor/major
-git push
-```
+All latest version deployments are handled by [semantic-release](https://github.com/semantic-release/semantic-release) which is triggered in CircleCI's `main` pipeline. _semantic-release_ will look at your commit message and determine how to increment the version based on its format. See [here](https://github.com/TrigenSoftware/simple-release/blob/main/GUIDE.md) for more details on how this works. [commitlint](https://commitlint.js.org/) hook is used to ensure your commit message is correct before pushing.
+  
+To summarise:
+- `feat` is a minor version bump
+- `fix` is a patch version bump
+- `perf` is a patch version bump
+- commit with `!` after the type (or scope) is a major version bump. Eg: `feat!: add image` or `feat(new)!: add image`
+- all other types do not cause any version bump
+
+_*This is fully customizable so can be updated to better suit our needs if required_
 
-Once a version has been pushed a PR needs to be opened for circleCI to trigger a build. There is no need to manage beta tags as this is done by circleCI.
+When the pull request is merged to main, the CircleCI main workflow runs which will perform all of the necessary npm publishing and git tagging, along with creating a Github release containing release notes.
 
-Any build deployed from a branch will be deployed as `1.0.0-beta.0` (1.0.0 being the version number that is defined in `package.json`)with the last value automatically incrementing.
+#### Beta deployments 
+All pull requests will deploy a beta version as part of the PR pipeline. This allows for easy testing without having to merge your PR. The version deployed will be `{CURRENT_MAJOR_VERSION}.0.0-PR${PULL_REQUEST_NUMBER}-BN${BUILD_NUM}`. For example: `7.0.0-PR100-BN150`
 
-The Pull Request should then be merged to main with final CircleCI workflow running, this will perform all of the npm publishing and git tagging that is required.
+#### Check the version your branch is using
+We do not keep track of the current version in package.json due to it not being necessary ([Why isn't it necessary?](https://semantic-release.gitbook.io/semantic-release/support/faq#it-is-not-needed-for-semantic-release-to-do-its-job)).
+However, to print out the package version your branch is using, run `npm run check-version`
 
 ## Usage
 

package/dist/AngleUpThin.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { SVGRProps } from './svgr';
+declare const AngleUpThin: ({ title, titleId, ...props }: SVGRProps) => React.JSX.Element;
+export default AngleUpThin;

package/dist/AngleUpThin.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+const AngleUpThin = ({ title, titleId, ...props }) => (React.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 448 512", "aria-labelledby": titleId, ...props },
+    title ? React.createElement("title", { id: titleId }, title) : null,
+    React.createElement("path", { fill: "currentColor", d: "M218.3 146.3c3.1-3.1 8.2-3.1 11.3 0l176 176c3.1 3.1 3.1 8.2 0 11.3s-8.2 3.1-11.3 0L224 163.3 53.7 333.7c-3.1 3.1-8.2 3.1-11.3 0s-3.1-8.2 0-11.3l176-176z" })));
+export default AngleUpThin;

package/dist/ArrowUpLight.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { SVGRProps } from './svgr';
+declare const ArrowUpLight: ({ title, titleId, ...props }: SVGRProps) => React.JSX.Element;
+export default ArrowUpLight;

package/dist/ArrowUpLight.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+const ArrowUpLight = ({ title, titleId, ...props }) => (React.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 384 512", "aria-labelledby": titleId, ...props },
+    title ? React.createElement("title", { id: titleId }, title) : null,
+    React.createElement("path", { fill: "currentColor", d: "M203.3 36.7c-6.2-6.2-16.4-6.2-22.6 0l-176 176c-6.2 6.2-6.2 16.4 0 22.6s16.4 6.2 22.6 0L176 86.6V464c0 8.8 7.2 16 16 16s16-7.2 16-16V86.6l148.7 148.7c6.2 6.2 16.4 6.2 22.6 0s6.2-16.4 0-22.6z" })));
+export default ArrowUpLight;

package/dist/DownloadRegular.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { SVGRProps } from './svgr';
+declare const DownloadRegular: ({ title, titleId, ...props }: SVGRProps) => React.JSX.Element;
+export default DownloadRegular;

package/dist/DownloadRegular.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+const DownloadRegular = ({ title, titleId, ...props }) => (React.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 512 512", "aria-labelledby": titleId, ...props },
+    title ? React.createElement("title", { id: titleId }, title) : null,
+    React.createElement("path", { fill: "currentColor", d: "M280 24c0-13.3-10.7-24-24-24s-24 10.7-24 24v270.1l-95-95c-9.4-9.4-24.6-9.4-33.9 0s-9.4 24.6 0 33.9L239 369c9.4 9.4 24.6 9.4 33.9 0L409 233c9.4-9.4 9.4-24.6 0-33.9s-24.6-9.4-33.9 0l-95 95V24zM128.8 304H64c-35.3 0-64 28.7-64 64v80c0 35.3 28.7 64 64 64h384c35.3 0 64-28.7 64-64v-80c0-35.3-28.7-64-64-64h-64.8l-48 48H448c8.8 0 16 7.2 16 16v80c0 8.8-7.2 16-16 16H64c-8.8 0-16-7.2-16-16v-80c0-8.8 7.2-16 16-16h112.8zM432 408a24 24 0 1 0-48 0 24 24 0 1 0 48 0" })));
+export default DownloadRegular;

package/dist/MicrophoneRegular.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { SVGRProps } from './svgr';
+declare const MicrophoneRegular: ({ title, titleId, ...props }: SVGRProps) => React.JSX.Element;
+export default MicrophoneRegular;

package/dist/MicrophoneRegular.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+const MicrophoneRegular = ({ title, titleId, ...props }) => (React.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 384 512", "aria-labelledby": titleId, ...props },
+    title ? React.createElement("title", { id: titleId }, title) : null,
+    React.createElement("path", { fill: "currentColor", d: "M240 96v160c0 26.5-21.5 48-48 48s-48-21.5-48-48V96c0-26.5 21.5-48 48-48s48 21.5 48 48M96 96v160c0 53 43 96 96 96s96-43 96-96V96c0-53-43-96-96-96S96 43 96 96M64 216c0-13.3-10.7-24-24-24s-24 10.7-24 24v40c0 89.1 66.2 162.7 152 174.4V464h-48c-13.3 0-24 10.7-24 24s10.7 24 24 24h144c13.3 0 24-10.7 24-24s-10.7-24-24-24h-48v-33.6c85.8-11.7 152-85.3 152-174.4v-40c0-13.3-10.7-24-24-24s-24 10.7-24 24v40c0 70.7-57.3 128-128 128S64 326.7 64 256z" })));
+export default MicrophoneRegular;

package/dist/SnoozeRegular.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { SVGRProps } from './svgr';
+declare const SnoozeRegular: ({ title, titleId, ...props }: SVGRProps) => React.JSX.Element;
+export default SnoozeRegular;

package/dist/SnoozeRegular.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+const SnoozeRegular = ({ title, titleId, ...props }) => (React.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 448 512", "aria-labelledby": titleId, ...props },
+    title ? React.createElement("title", { id: titleId }, title) : null,
+    React.createElement("path", { fill: "currentColor", d: "M184 0c-13.3 0-24 10.7-24 24s10.7 24 24 24h59.1l-77.2 88.2c-6.2 7.1-7.7 17.1-3.8 25.7S174.6 176 184 176h112c13.3 0 24-10.7 24-24s-10.7-24-24-24h-59.1l77.2-88.2c6.2-7.1 7.7-17.1 3.8-25.7S305.4 0 296 0zm128 224c-13.3 0-24 10.7-24 24s10.7 24 24 24h62.9l-81.8 105.3c-5.6 7.2-6.6 17-2.6 25.3s12.4 13.5 21.6 13.5H424c13.3 0 24-10.7 24-24s-10.7-24-24-24h-62.9L443 262.8c5.6-7.2 6.6-17 2.6-25.3S433.2 224 424 224zm-288 0c-13.3 0-24 10.7-24 24s10.7 24 24 24h128.6L4.6 473.8c-5.3 7.3-6.1 17-2.1 25S15 512 24 512h176c13.3 0 24-10.7 24-24s-10.7-24-24-24H71.4l148-201.8c5.3-7.3 6.1-17 2.1-25S209 224 200 224z" })));
+export default SnoozeRegular;

package/dist/SpinnerRegular.d.ts

@@ -0,0 +1,4 @@
+import * as React from 'react';
+import { SVGRProps } from './svgr';
+declare const SpinnerRegular: ({ title, titleId, ...props }: SVGRProps) => React.JSX.Element;
+export default SpinnerRegular;

package/dist/SpinnerRegular.js

@@ -0,0 +1,5 @@
+import * as React from 'react';
+const SpinnerRegular = ({ title, titleId, ...props }) => (React.createElement("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 512 512", "aria-labelledby": titleId, ...props },
+    title ? React.createElement("title", { id: titleId }, title) : null,
+    React.createElement("path", { fill: "currentColor", d: "M288 32a32 32 0 1 0-64 0 32 32 0 1 0 64 0m0 448a32 32 0 1 0-64 0 32 32 0 1 0 64 0m160-224a32 32 0 1 0 64 0 32 32 0 1 0-64 0M32 288a32 32 0 1 0 0-64 32 32 0 1 0 0 64m43 149a32 32 0 1 0 45.3-45.3A32 32 0 1 0 75 437m316.8 0a32 32 0 1 0 45.2-45.2 32 32 0 1 0-45.2 45.2M75 75a32 32 0 1 0 45.3 45.3A32 32 0 1 0 75 75" })));
+export default SpinnerRegular;

package/dist/index.d.ts

@@ -5,6 +5,7 @@ export { default as AngleLeftThin } from './AngleLeftThin';
 export { default as AngleRightLight } from './AngleRightLight';
 export { default as AngleRightThin } from './AngleRightThin';
 export { default as AngleUpLight } from './AngleUpLight';
+export { default as AngleUpThin } from './AngleUpThin';
 export { default as ArrowLeftLight } from './ArrowLeftLight';
 export { default as ArrowPointerRegular } from './ArrowPointerRegular';
 export { default as ArrowPointerThin } from './ArrowPointerThin';
@@ -13,6 +14,7 @@ export { default as ArrowRightFromBracketThin } from './ArrowRightFromBracketThi
 export { default as ArrowRightLight } from './ArrowRightLight';
 export { default as ArrowRotateRightLight } from './ArrowRotateRightLight';
 export { default as ArrowTrendUpLight } from './ArrowTrendUpLight';
+export { default as ArrowUpLight } from './ArrowUpLight';
 export { default as ArrowUpRightAndArrowDownLeftFromCenterLight } from './ArrowUpRightAndArrowDownLeftFromCenterLight';
 export { default as ArrowUpRightFromSquareLight } from './ArrowUpRightFromSquareLight';
 export { default as ArrowsRotateLight } from './ArrowsRotateLight';
@@ -89,6 +91,7 @@ export { default as CreditCardThin } from './CreditCardThin';
 export { default as DesktopLight } from './DesktopLight';
 export { default as DiagramCellsLight } from './DiagramCellsLight';
 export { default as DownloadLight } from './DownloadLight';
+export { default as DownloadRegular } from './DownloadRegular';
 export { default as EarListenLight } from './EarListenLight';
 export { default as EarthAfricaLight } from './EarthAfricaLight';
 export { default as EllipsisLight } from './EllipsisLight';
@@ -208,6 +211,7 @@ export { default as MessageTextLight } from './MessageTextLight';
 export { default as MessageTextThin } from './MessageTextThin';
 export { default as MessageThin } from './MessageThin';
 export { default as MessagesLight } from './MessagesLight';
+export { default as MicrophoneRegular } from './MicrophoneRegular';
 export { default as MinusLight } from './MinusLight';
 export { default as MobileLight } from './MobileLight';
 export { default as MoneyBillTransferLight } from './MoneyBillTransferLight';
@@ -271,6 +275,7 @@ export { default as SidebarLight } from './SidebarLight';
 export { default as SitemapLight } from './SitemapLight';
 export { default as SkypeBrands } from './SkypeBrands';
 export { default as SlackBrands } from './SlackBrands';
+export { default as SnoozeRegular } from './SnoozeRegular';
 export { default as SnowflakeLight } from './SnowflakeLight';
 export { default as SortDownLight } from './SortDownLight';
 export { default as SortLight } from './SortLight';
@@ -278,6 +283,7 @@ export { default as SortUpLight } from './SortUpLight';
 export { default as SparklesLight } from './SparklesLight';
 export { default as SparklesRegular } from './SparklesRegular';
 export { default as SparklesSolid } from './SparklesSolid';
+export { default as SpinnerRegular } from './SpinnerRegular';
 export { default as SpinnerThirdDuotoneSolid } from './SpinnerThirdDuotoneSolid';
 export { default as SpotifyBrands } from './SpotifyBrands';
 export { default as SquareArrowUpRightLight } from './SquareArrowUpRightLight';

package/dist/index.js

@@ -5,6 +5,7 @@ export { default as AngleLeftThin } from './AngleLeftThin';
 export { default as AngleRightLight } from './AngleRightLight';
 export { default as AngleRightThin } from './AngleRightThin';
 export { default as AngleUpLight } from './AngleUpLight';
+export { default as AngleUpThin } from './AngleUpThin';
 export { default as ArrowLeftLight } from './ArrowLeftLight';
 export { default as ArrowPointerRegular } from './ArrowPointerRegular';
 export { default as ArrowPointerThin } from './ArrowPointerThin';
@@ -13,6 +14,7 @@ export { default as ArrowRightFromBracketThin } from './ArrowRightFromBracketThi
 export { default as ArrowRightLight } from './ArrowRightLight';
 export { default as ArrowRotateRightLight } from './ArrowRotateRightLight';
 export { default as ArrowTrendUpLight } from './ArrowTrendUpLight';
+export { default as ArrowUpLight } from './ArrowUpLight';
 export { default as ArrowUpRightAndArrowDownLeftFromCenterLight } from './ArrowUpRightAndArrowDownLeftFromCenterLight';
 export { default as ArrowUpRightFromSquareLight } from './ArrowUpRightFromSquareLight';
 export { default as ArrowsRotateLight } from './ArrowsRotateLight';
@@ -89,6 +91,7 @@ export { default as CreditCardThin } from './CreditCardThin';
 export { default as DesktopLight } from './DesktopLight';
 export { default as DiagramCellsLight } from './DiagramCellsLight';
 export { default as DownloadLight } from './DownloadLight';
+export { default as DownloadRegular } from './DownloadRegular';
 export { default as EarListenLight } from './EarListenLight';
 export { default as EarthAfricaLight } from './EarthAfricaLight';
 export { default as EllipsisLight } from './EllipsisLight';
@@ -208,6 +211,7 @@ export { default as MessageTextLight } from './MessageTextLight';
 export { default as MessageTextThin } from './MessageTextThin';
 export { default as MessageThin } from './MessageThin';
 export { default as MessagesLight } from './MessagesLight';
+export { default as MicrophoneRegular } from './MicrophoneRegular';
 export { default as MinusLight } from './MinusLight';
 export { default as MobileLight } from './MobileLight';
 export { default as MoneyBillTransferLight } from './MoneyBillTransferLight';
@@ -271,6 +275,7 @@ export { default as SidebarLight } from './SidebarLight';
 export { default as SitemapLight } from './SitemapLight';
 export { default as SkypeBrands } from './SkypeBrands';
 export { default as SlackBrands } from './SlackBrands';
+export { default as SnoozeRegular } from './SnoozeRegular';
 export { default as SnowflakeLight } from './SnowflakeLight';
 export { default as SortDownLight } from './SortDownLight';
 export { default as SortLight } from './SortLight';
@@ -278,6 +283,7 @@ export { default as SortUpLight } from './SortUpLight';
 export { default as SparklesLight } from './SparklesLight';
 export { default as SparklesRegular } from './SparklesRegular';
 export { default as SparklesSolid } from './SparklesSolid';
+export { default as SpinnerRegular } from './SpinnerRegular';
 export { default as SpinnerThirdDuotoneSolid } from './SpinnerThirdDuotoneSolid';
 export { default as SpotifyBrands } from './SpotifyBrands';
 export { default as SquareArrowUpRightLight } from './SquareArrowUpRightLight';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@benefex/icons",
-  "version": "0.7.0",
+  "version": "0.8.0",
   "description": "Benefex icon package",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,6 +10,7 @@
   ],
   "scripts": {
     "test": "npx jest --coverage",
+    "ci-test": "CI=true npm test -- --coverage --ci --runInBand",
     "lint": "echo 'No linting'",
     "clean": "rm -rf ./generated && rm -rf ./dist",
     "build:icons": "npx @svgr/cli --out-dir generated ./src/svgs/ && cp src/svgr.ts generated",
@@ -17,7 +18,14 @@
     "build": "npm run clean && npm run build:icons && npm run build:tsc",
     "prepublishOnly": "npm run build",
     "storybook": "npm run build && storybook dev -p 6006",
-    "build-storybook": "npm run build && storybook build"
+    "build-storybook": "npm run build && storybook build",
+    "prepare": "husky",
+    "check-version": "git fetch --tags && git describe --tags --abbrev=0"
+  },
+  "commitlint": {
+    "extends": [
+      "@commitlint/config-conventional"
+    ]
   },
   "repository": {
     "type": "git",
@@ -34,6 +42,8 @@
   },
   "homepage": "https://github.com/BenefexLtd/onehub-icons#readme",
   "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
     "@storybook/addon-essentials": "^8.1.10",
     "@storybook/addon-links": "^8.1.10",
     "@storybook/blocks": "^8.1.10",
@@ -43,6 +53,7 @@
     "@types/react": "^18.3.3",
     "@types/react-dom": "^18.3.0",
     "camelcase": "^8.0.0",
+    "husky": "^9.1.6",
     "jest": "^29.7.0",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
@@ -51,5 +62,8 @@
   },
   "peerDependencies": {
     "react": "16 - 18"
+  },
+  "dependencies": {
+    "conventional-changelog-conventionalcommits": "^9.1.0"
   }
 }