@brazilian-utils/brazilian-utils - npm Package Compare versions

Comparing version 1.0.0-rc.7 to 1.0.0-rc.8

CHANGELOG.md

@@ -0,1 +1,20 @@
+<a name="1.0.0-rc.8"></a>
+# [1.0.0-rc.8](https://github.com/brazilian-utils/brazilian-utils/compare/1.0.0-rc.7...1.0.0-rc.8) (2020-06-17)
+
+
+### Bug Fixes
+
+* add getCities to api public testes ([3f8c4be](https://github.com/brazilian-utils/brazilian-utils/commit/3f8c4be))
+* adjust docs typo ([89cf335](https://github.com/brazilian-utils/brazilian-utils/commit/89cf335))
+* adjust responsive docs ([bafcdc0](https://github.com/brazilian-utils/brazilian-utils/commit/bafcdc0))
+* export getCities ([0472144](https://github.com/brazilian-utils/brazilian-utils/commit/0472144))
+* update-cities script command ([bce5628](https://github.com/brazilian-utils/brazilian-utils/commit/bce5628))
+
+
+### Features
+
+* add utility getCities ([ebb949d](https://github.com/brazilian-utils/brazilian-utils/commit/ebb949d))
+* black lives matters ([cce58d8](https://github.com/brazilian-utils/brazilian-utils/commit/cce58d8))
+* change the way the cities are filtered. Add docs ([7f4ca6d](https://github.com/brazilian-utils/brazilian-utils/commit/7f4ca6d))
+
 <a name="1.0.0-rc.7"></a>
@@ -2,0 +21,0 @@ # [1.0.0-rc.7](https://github.com/brazilian-utils/brazilian-utils/compare/1.0.0-rc.6...1.0.0-rc.7) (2020-05-05)

dist/common/states.d.ts

@@ -166,2 +166,4 @@ export declare const STATES_DATA: {
 export declare type State = keyof typeof STATES_DATA;
+export declare type StateCode = State;
+export declare type StateName = 'Acre' | 'Alagoas' | 'Amapá' | 'Amazonas' | 'Bahia' | 'Ceará' | 'Distrito Federal' | 'Espírito Santo' | 'Goiás' | 'Maranhão' | 'Minas Gerais' | 'Mato Grosso' | 'Mato Grosso do Sul' | 'Pará' | 'Paraíba' | 'Pernambuco' | 'Piauí' | 'Paraná' | 'Rio de Janeiro' | 'Rio Grande do Norte' | 'Rondônia' | 'Rio Grande do Sul' | 'Roraima' | 'Santa Catarina' | 'Sergipe' | 'São Paulo' | 'Tocantins';
 export declare const STATES: ("AC" | "AL" | "AP" | "AM" | "BA" | "CE" | "DF" | "ES" | "GO" | "MA" | "MG" | "MT" | "MS" | "PA" | "PB" | "PE" | "PI" | "PR" | "RJ" | "RN" | "RO" | "RS" | "RR" | "SC" | "SE" | "SP" | "TO")[];

dist/utilities/index.d.ts

@@ -11,1 +11,2 @@ export { isValid as isValidIE } from './inscricao-estadual';
 export * from './states';
+export { getCities } from './cities';

dist/utilities/states/index.d.ts

@@ -0,5 +1,7 @@
+import { StateCode, StateName } from '../../common/states';
 export interface State {
-    code: string;
-    name: string;
+    code: StateCode;
+    name: StateName;
 }
+export { StateCode, StateName };
 export declare function getStates(): State[];

package.json

 {
   "name": "@brazilian-utils/brazilian-utils",
-  "version": "1.0.0-rc.7",
+  "version": "1.0.0-rc.8",
   "main": "dist/index.js",
@@ -13,2 +13,3 @@ "module": "dist/brazilianUtils.esm.js",
     "start": "tsdx watch",
+    "prebuild": "npm run update-cities",
     "build": "tsdx build",
@@ -21,3 +22,4 @@ "prepublish": "npm run build",
     "release": "release-it",
-    "docs": "docsify serve docs"
+    "docs": "docsify serve docs",
+    "update-cities": "node scripts/getCitiesFromIBGE.js && prettier --write ./src/common/cities.ts"
   },
@@ -64,2 +66,3 @@ "husky": {
     "lint-staged": "^10.1.7",
+    "node-fetch": "^2.6.0",
     "prettier": "^2.0.5",
@@ -66,0 +69,0 @@ "release-it": "^13.5.5",

README.md

@@ -5,12 +5,15 @@ # 🇧🇷 Brazilian Utils
 
-Utils library for specific Brazilian businesses.
+Utils library for Brazilian-specific businesses.
 
 ---
-
+>## Vidas Negras Importam | Black Lives Matter. ✊🏽✊🏾✊🏿
+>To know how to help, just go to [Vidas Negras Importam](https://vidasnegrasimportam.carrd.co/) or [Black Lives Matter](https://blacklivesmatters.carrd.co/).
+---
 >## We are changing
->After one year of Brazilian Utils and a lot of feedbacks, we decide to refactoring our library to fix issues, create a website and make easier for other developers to contribute. If you use **v0 version**, please, check [v0](https://github.com/brazilian-utils/brazilian-utils/tree/v0) branch.
+>After one year of Brazilian Utils and lots of feedback, we decided to refactor our library to fix issues, create a website and make it easier for other developers to contribute. If you use **v0 version**, please, check [v0](https://github.com/brazilian-utils/brazilian-utils/tree/v0) branch.
+---
 
 ## Contributors
 
-Thanks go to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
+Our "thank you" goes to these wonderful people ([emoji key](https://github.com/kentcdodds/all-contributors#emoji-key)):
 
@@ -42,2 +45,5 @@ <!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
     <td align="center"><a href="https://github.com/arfurlaneto"><img src="https://avatars0.githubusercontent.com/u/3330854?v=4" width="100px;" alt=""/><br /><sub><b>Antonio Roberto Furlaneto</b></sub></a><br /><a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=arfurlaneto" title="Code">💻</a> <a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=arfurlaneto" title="Documentation">📖</a> <a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=arfurlaneto" title="Tests">⚠️</a></td>
+    <td align="center"><a href="https://www.linkedin.com/in/felipe-nolleto-nascimento-a2a23788/"><img src="https://avatars2.githubusercontent.com/u/2437673?v=4" width="100px;" alt=""/><br /><sub><b>Felipe Nolleto Nascimento</b></sub></a><br /><a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=nolleto" title="Code">💻</a> <a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=nolleto" title="Documentation">📖</a> <a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=nolleto" title="Tests">⚠️</a></td>
+    <td align="center"><a href="http://linkedin.com/in/saulojoab"><img src="https://avatars2.githubusercontent.com/u/37988252?v=4" width="100px;" alt=""/><br /><sub><b>Saulo Joab</b></sub></a><br /><a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=saulojoab" title="Documentation">📖</a></td>
+    <td align="center"><a href="http://fb.com/arantespp"><img src="https://avatars0.githubusercontent.com/u/16626980?v=4" width="100px;" alt=""/><br /><sub><b>Pedro Arantes</b></sub></a><br /><a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=arantespp" title="Code">💻</a> <a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=arantespp" title="Documentation">📖</a> <a href="https://github.com/brazilian-utils/brazilian-utils/commits?author=arantespp" title="Tests">⚠️</a></td>
   </tr>
@@ -44,0 +50,0 @@ </table>

No alert changes

Improved metrics

Total package byte prevSize

1189911

increased by204.82%

Number of package files

59

increased by3.51%

Lines of code

4449

increased by30.51%

Number of lines in readme file

59

increased by11.32%

Worsened metrics

Dev dependency count

13

increased by8.33%

No dependency changes