fix: disable docs generation on ci and update docs

ericvera · May 15, 2024 · c9fd7d3 · c9fd7d3
1 parent 2720065
commit c9fd7d3
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 7 deletions.
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,6 +1,8 @@
 #!/usr/bin/env sh
 
-yarn docs
+# Do not run docs on CI
+yarn is-ci || yarn docs
+
 yarn lint-staged
 
 # Check if there are unstaged changes to README.md

diff --git a/docs/functions/getPartialE164PhoneNumber.md b/docs/functions/getPartialE164PhoneNumber.md
@@ -14,12 +14,12 @@ phone numbers in input fields as the user types.
 
 ## Parameters
 
-| Parameter                      | Type                    | Description                                                                                                                                                                                                                                              |
-| :----------------------------- | :---------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `phoneNumber`                  | `undefined` \| `string` | The phone number to format.                                                                                                                                                                                                                              |
-| `defaultCountryInfo`           | `object`                | The default country code and max length for the<br />desired country. In the case where the code is matched, the phone number will<br />be truncated at maxLength including the plus sign. (Defaults to +1 and 12<br />characters for US phone numbers.) |
-| `defaultCountryInfo.code`      | `string`                | -                                                                                                                                                                                                                                                        |
-| `defaultCountryInfo.maxLength` | `number`                | -                                                                                                                                                                                                                                                        |
+| Parameter                      | Type                    | Description                                                                                                                                                                                                                               |
+| :----------------------------- | :---------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `phoneNumber`                  | `undefined` \| `string` | The phone number to format.                                                                                                                                                                                                               |
+| `defaultCountryInfo`           | `object`                | The default country code and max length for the desired country. In the case where the code is matched, the phone number will be truncated at maxLength including the plus sign. (Defaults to +1 and 12 characters for US phone numbers.) |
+| `defaultCountryInfo.code`      | `string`                | -                                                                                                                                                                                                                                         |
+| `defaultCountryInfo.maxLength` | `number`                | -                                                                                                                                                                                                                                         |
 
 ## Returns
 

diff --git a/package.json b/package.json
@@ -32,6 +32,7 @@
     "@types/node": "^20.12.12",
     "eslint": "^9.2.0",
     "husky": "^9.0.11",
+    "is-ci": "^3.0.1",
     "lint-staged": "^15.2.2",
     "pinst": "^3.0.0",
     "prettier": "^3.2.5",

diff --git a/yarn.lock b/yarn.lock
@@ -892,6 +892,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"ci-info@npm:^3.2.0":
+  version: 3.9.0
+  resolution: "ci-info@npm:3.9.0"
+  checksum: 10c0/6f0109e36e111684291d46123d491bc4e7b7a1934c3a20dea28cba89f1d4a03acd892f5f6a81ed3855c38647e285a150e3c9ba062e38943bef57fee6c1554c3a
+  languageName: node
+  linkType: hard
+
 "clean-stack@npm:^2.0.0":
   version: 2.2.0
   resolution: "clean-stack@npm:2.2.0"
@@ -1019,6 +1026,7 @@ __metadata:
     "@types/node": "npm:^20.12.12"
     eslint: "npm:^9.2.0"
     husky: "npm:^9.0.11"
+    is-ci: "npm:^3.0.1"
     lint-staged: "npm:^15.2.2"
     pinst: "npm:^3.0.0"
     prettier: "npm:^3.2.5"
@@ -1643,6 +1651,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"is-ci@npm:^3.0.1":
+  version: 3.0.1
+  resolution: "is-ci@npm:3.0.1"
+  dependencies:
+    ci-info: "npm:^3.2.0"
+  bin:
+    is-ci: bin.js
+  checksum: 10c0/0e81caa62f4520d4088a5bef6d6337d773828a88610346c4b1119fb50c842587ed8bef1e5d9a656835a599e7209405b5761ddf2339668f2d0f4e889a92fe6051
+  languageName: node
+  linkType: hard
+
 "is-extglob@npm:^2.1.1":
   version: 2.1.1
   resolution: "is-extglob@npm:2.1.1"