@sankhyalabs/core 5.7.1 → 5.8.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 (9) hide show
  1. package/.docs/README.md +39 -33
  2. package/.husky/commit-msg +4 -0
  3. package/.releaserc +53 -37
  4. package/README.md +39 -33
  5. package/commitlint.config.cjs +14 -0
  6. package/package.json +10 -12
  7. package/.reusable-default-scripts.yml +0 -26
  8. package/build.env +0 -0
  9. package/publish-docs.sh +0 -11
package/.docs/README.md CHANGED
@@ -2,56 +2,62 @@
2
2
 
3
3
  # @sankhyalabs/core
4
4
 
5
- ### Intro
6
5
  Esse projeto é responsavél por disponibilizar utilitários JavaScript comuns entre vários projetos.
7
6
 
8
- # Como usar
7
+ ## ❓ Como usar
8
+
9
+ ---
10
+
11
+ Instale as dependências:
9
12
 
10
13
  ```sh
11
14
  $ npm install @sankhyalabs/core
12
15
  ```
13
16
 
17
+ E utilize as funcionalidades:
18
+
14
19
  ```ts
15
- import { StringUtils } from '@sankhyalabs/core'
20
+ import {StringUtils} from '@sankhyalabs/core'
16
21
 
17
- function test(){
22
+ function test() {
18
23
  alert(StringUtils.isEmpty(''));
19
24
  }
20
25
  ```
21
- # Executar testes
22
- ```sh
23
- $ npm t
24
- ```
25
- # Como contribuir
26
- - Criar uma branch com nome sugestivo para o problema/melhoria.
27
- - Dentro do projeto criar uma pasta chamada "change_proposal" dentro dessa pasta deverá existir um exemplo do caso de uso/problema que você está resolvendo.
28
- - Realizar as alterações.
29
- - Criar caso de teste para o problema que você está resolvendo.
30
- - Fazer commit na branch.
31
- - Abrir MR para master, na descrição do MR, colocar a seguinte documentação :arrow_down:
32
26
 
33
- ##### Tipo de problema:
34
- - [ ] Hotfix
35
- - [ ] Feature
36
- ##### Ambiente simulação:
37
- - [ ] Teste/Desenvolvimento
38
- - [ ] Produçãp
27
+ ## ⁉️ Como contribuir
39
28
 
40
- ##### Nome do projeto de origem (core, flow, wms...):
29
+ ---
41
30
 
42
- ##### Descrição do problema:
31
+ 1. Crie uma branch com nome dentro
32
+ dos [padrões semânticos](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
33
+ 2. Realize as alterações para resolução das suas tarefas
34
+ 3. Se possível,
35
+ crie [casos de teste](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o#testes)
36
+ para a tarefa que você está executando
37
+ 4. Faça os commits dentro
38
+ dos [padrões semânticos](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191) para
39
+ a sua branch
40
+ 5. Abra um merge request para a branch alvo com as informações de acordo
43
41
 
44
- ##### Num.OS de origem(caso exista):
42
+ > Por favor, siga os padrões de código descritos
43
+ > em [nossa Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)!
45
44
 
46
- #
47
- #
48
- #
49
- #
45
+ ## ⚡ Utilitários
50
46
 
51
- ### Build em ambiente de desenvolvimento
47
+ ---
52
48
 
53
- ```sh
54
- $ npm run build --watch
55
- ```
49
+ Aqui estão alguns utilitários que podem ajudar a melhorar a experiência de uso do **sankhyacore**:
50
+
51
+ - Projeto [cz-sankhya](https://git.sankhya.com.br/ferramentas/devops/semantic-release/cz-sankhya) - é um adaptador que
52
+ extende as funcionalidades do [commitizen](https://github.com/commitizen/cz-cli), e que te ajuda a escrever mensagens
53
+ de commit bem formatadas e guiadas, de maneira interativa e assertiva.
54
+
55
+ #### Links comunidade Sankhya Developer 🧠
56
56
 
57
- Veja mais informações em nossa [Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)
57
+ - [Semantic Version](https://comunidade.sankhya.com.br/t/versionamento-semantico-sem-complicacao/7184)
58
+ - [Padrão de nomenclatura de branches](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
59
+ - Fluxo de trabalho
60
+ - [Branch feat-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-feat-dev/7226/1)
61
+ - [Branch bugfix-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-bugfix-dev/7190)
62
+ - [Branch hotfix-ga](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-hotfix-ga/7233)
63
+ - [cz-sankhya](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191)
package/.husky/commit-msg ADDED
@@ -0,0 +1,4 @@
1
+ #!/usr/bin/env sh
2
+ . "$(dirname -- "$0")/_/husky.sh"
3
+
4
+ npx --no -- commitlint --edit ${1}
package/.releaserc CHANGED
@@ -1,42 +1,58 @@
1
1
  {
2
- "plugins": [
3
- [
4
- "@semantic-release/commit-analyzer",
5
- {
6
- "preset": "angular",
7
- "releaseRules": [
8
- {
9
- "type": "breaking",
10
- "scope": "API",
11
- "release": "major"
12
- }
13
- ]
14
- }
15
- ],
2
+ "tagFormat": "v${version}",
3
+ "branches": [
4
+ "master",
5
+ { "name": "develop", "channel": "dev", "prerelease": "dev" },
6
+ { "name": "release", "channel": "rc", "prerelease": "rc" }
7
+ ],
8
+ "plugins": [
9
+ [
10
+ "@semantic-release/commit-analyzer",
11
+ {
12
+ "preset": "conventionalcommits",
13
+ "releaseRules": [
14
+ { "breaking": true, "release": "major" } ,
15
+ { "revert": true, "release": "patch" } ,
16
+ { "type": "feat", "release": "minor" } ,
17
+ { "type": "fix", "release": "patch" } ,
18
+ { "type": "perf", "release": "patch" } ,
19
+ { "type": "refactor", "release": "patch" } ,
20
+ { "type": "build", "release": "patch" } ,
21
+ { "type": "ci", "release": "patch" } ,
22
+ { "scope": "no-release", "release": false }
23
+ ]
24
+ }
25
+ ],
26
+ [
16
27
  "@semantic-release/release-notes-generator",
17
- [
18
- "@semantic-release/npm",
19
- {
20
- "npmPublish": true
21
- }
22
- ],
23
- [
24
- "@semantic-release/gitlab",
25
- {
26
- "gitlabUrl": "https://git.sankhya.com.br",
27
- "gitlabApiPathPrefix": "/api/v4"
28
- }
29
- ],
30
- [
31
- "@semantic-release/exec",
32
- {
33
- "successCmd": "echo 'PUBLISHED_NEXT_VERSION=${nextRelease.version}' >> ./build.env"
28
+ {
29
+ "preset": "conventionalcommits",
30
+ "presetConfig": {
31
+ "types": [
32
+ { "type": "feat" , "section": "Features" },
33
+ { "type": "fix" , "section": "Bug Fixes" },
34
+ { "type": "refactor", "section": "Refactor" , "hidden": false },
35
+ { "type": "ci" , "section": "Build projects", "hidden": false },
36
+ { "type": "build" , "section": "Build projects", "hidden": false }
37
+ ]
34
38
  }
35
- ]
39
+ }
40
+ ],
41
+ [
42
+ "@semantic-release/exec",
43
+ { "verifyReleaseCmd": "echo ${nextRelease.version} > .VERSION" }
36
44
  ],
37
- "branches": [
38
- {"name": "master"},
39
- {"name": "beta", "channel": "beta", "prerelease": true},
40
- "+([0-9])?(.{+([0-9]),x}).x"
45
+ "@semantic-release/changelog",
46
+ "@semantic-release/gitlab",
47
+ [
48
+ "@sankhyalabs/semantic-release-backmerge",
49
+ {
50
+ "branches": [
51
+ { "from": "master" , "to": "develop" },
52
+ { "from": "master" , "to": "release" },
53
+ { "from": "release", "to": "develop" }
54
+ ]
55
+ }
41
56
  ]
42
- }
57
+ ]
58
+ }
package/README.md CHANGED
@@ -1,56 +1,62 @@
1
1
  # @sankhyalabs/core
2
2
 
3
- ### Intro
4
3
  Esse projeto é responsavél por disponibilizar utilitários JavaScript comuns entre vários projetos.
5
4
 
6
- # Como usar
5
+ ## ❓ Como usar
6
+
7
+ ---
8
+
9
+ Instale as dependências:
7
10
 
8
11
  ```sh
9
12
  $ npm install @sankhyalabs/core
10
13
  ```
11
14
 
15
+ E utilize as funcionalidades:
16
+
12
17
  ```ts
13
- import { StringUtils } from '@sankhyalabs/core'
18
+ import {StringUtils} from '@sankhyalabs/core'
14
19
 
15
- function test(){
20
+ function test() {
16
21
  alert(StringUtils.isEmpty(''));
17
22
  }
18
23
  ```
19
- # Executar testes
20
- ```sh
21
- $ npm t
22
- ```
23
- # Como contribuir
24
- - Criar uma branch com nome sugestivo para o problema/melhoria.
25
- - Dentro do projeto criar uma pasta chamada "change_proposal" dentro dessa pasta deverá existir um exemplo do caso de uso/problema que você está resolvendo.
26
- - Realizar as alterações.
27
- - Criar caso de teste para o problema que você está resolvendo.
28
- - Fazer commit na branch.
29
- - Abrir MR para master, na descrição do MR, colocar a seguinte documentação :arrow_down:
30
24
 
31
- ##### Tipo de problema:
32
- - [ ] Hotfix
33
- - [ ] Feature
34
- ##### Ambiente simulação:
35
- - [ ] Teste/Desenvolvimento
36
- - [ ] Produçãp
25
+ ## ⁉️ Como contribuir
37
26
 
38
- ##### Nome do projeto de origem (core, flow, wms...):
27
+ ---
39
28
 
40
- ##### Descrição do problema:
29
+ 1. Crie uma branch com nome dentro
30
+ dos [padrões semânticos](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
31
+ 2. Realize as alterações para resolução das suas tarefas
32
+ 3. Se possível,
33
+ crie [casos de teste](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o#testes)
34
+ para a tarefa que você está executando
35
+ 4. Faça os commits dentro
36
+ dos [padrões semânticos](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191) para
37
+ a sua branch
38
+ 5. Abra um merge request para a branch alvo com as informações de acordo
41
39
 
42
- ##### Num.OS de origem(caso exista):
40
+ > Por favor, siga os padrões de código descritos
41
+ > em [nossa Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)!
43
42
 
44
- #
45
- #
46
- #
47
- #
43
+ ## ⚡ Utilitários
48
44
 
49
- ### Build em ambiente de desenvolvimento
45
+ ---
50
46
 
51
- ```sh
52
- $ npm run build --watch
53
- ```
47
+ Aqui estão alguns utilitários que podem ajudar a melhorar a experiência de uso do **sankhyacore**:
48
+
49
+ - Projeto [cz-sankhya](https://git.sankhya.com.br/ferramentas/devops/semantic-release/cz-sankhya) - é um adaptador que
50
+ extende as funcionalidades do [commitizen](https://github.com/commitizen/cz-cli), e que te ajuda a escrever mensagens
51
+ de commit bem formatadas e guiadas, de maneira interativa e assertiva.
52
+
53
+ #### Links comunidade Sankhya Developer 🧠
54
54
 
55
- Veja mais informações em nossa [Wiki](https://git.sankhya.com.br/sankhyalabs/sankhyacore/-/wikis/Diretrizes-de-Codifica%C3%A7%C3%A3o)
55
+ - [Semantic Version](https://comunidade.sankhya.com.br/t/versionamento-semantico-sem-complicacao/7184)
56
+ - [Padrão de nomenclatura de branches](https://comunidade.sankhya.com.br/t/sankhya-gitflow-padroes-de-nomenclatura-de-branch-para-um-fluxo-de-desenvolvimento-eficiente/7189)
57
+ - Fluxo de trabalho
58
+ - [Branch feat-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-feat-dev/7226/1)
59
+ - [Branch bugfix-dev](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-bugfix-dev/7190)
60
+ - [Branch hotfix-ga](https://comunidade.sankhya.com.br/t/sankhya-gitflow-fluxo-de-trabalho-de-uma-branch-hotfix-ga/7233)
61
+ - [cz-sankhya](https://comunidade.sankhya.com.br/t/formatando-mensagens-de-commit-com-cz-sankhya/7191)
56
62
 
package/commitlint.config.cjs ADDED
@@ -0,0 +1,14 @@
1
+ module.exports = {
2
+ extends: ['@commitlint/config-conventional'],
3
+ rules: {
4
+ 'type-enum': [2, 'always', ['feat', 'fix', 'docs', 'ci']],
5
+ 'references-empty': [2, 'never'],
6
+ 'subject-case': [0, 'never']
7
+ },
8
+ parserPreset: {
9
+ parserOpts: {
10
+ issuePrefixes: ['(KB|kb|SKA|ska|OS|os)[-:][0-9]+'],
11
+ issuePrefixesCaseSensitive: true
12
+ }
13
+ }
14
+ };
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core",
3
- "version": "5.7.1",
3
+ "version": "5.8.0",
4
4
  "description": "Modulo core JavaScript da Sankhya.",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.js",
7
7
  "type": "module",
8
8
  "types": "dist/index.d.ts",
9
9
  "scripts": {
10
- "build": "npm t && tsc",
10
+ "build": "tsc",
11
11
  "build:watch": "tsc --watch",
12
12
  "compile": "tsc",
13
13
  "test": "jest",
@@ -15,8 +15,8 @@
15
15
  "serve": "es-dev-server --node-resolve --watch",
16
16
  "eslint": "eslint src/**",
17
17
  "link-dev": "npm run build:watch",
18
- "semantic-release": "semantic-release",
19
- "docs": "typedoc --plugin typedoc-plugin-markdown --out .docs src/*.ts"
18
+ "docs": "typedoc --plugin typedoc-plugin-markdown --out .docs src/*.ts",
19
+ "prepare": "husky install"
20
20
  },
21
21
  "author": "leonardo.jorge",
22
22
  "license": "ISC",
@@ -31,10 +31,8 @@
31
31
  "uuid": "^9.0.0"
32
32
  },
33
33
  "devDependencies": {
34
- "@semantic-release/exec": "^5.0.0",
35
- "@semantic-release/git": "^9.0.0",
36
- "@semantic-release/gitlab": "^6.1.0",
37
- "@semantic-release/npm": "^7.1.3",
34
+ "@commitlint/cli": "^18.4.3",
35
+ "@commitlint/config-conventional": "^18.4.3",
38
36
  "@types/jest": "^29.4.0",
39
37
  "@types/node": "^18.11.18",
40
38
  "@typescript-eslint/eslint-plugin": "^5.27.0",
@@ -42,13 +40,13 @@
42
40
  "es-dev-server": "^1.60.2",
43
41
  "eslint": "^8.16.0",
44
42
  "eslint-plugin-import": "^2.26.0",
43
+ "husky": "^8.0.3",
45
44
  "jest": "^29.4.1",
46
- "semantic-release": "^17.4.3",
45
+ "jest-environment-jsdom": "^29.4.1",
47
46
  "ts-jest": "^29.0.5",
48
47
  "ts-node": "^10.9.1",
49
- "typescript": "^4.9.5",
50
- "jest-environment-jsdom": "^29.4.1",
51
48
  "typedoc": "^0.23.24",
52
- "typedoc-plugin-markdown": "^3.14.0"
49
+ "typedoc-plugin-markdown": "^3.14.0",
50
+ "typescript": "^4.9.5"
53
51
  }
54
52
  }
package/.reusable-default-scripts.yml DELETED
@@ -1,26 +0,0 @@
1
- .reusable-default-scripts:
2
-
3
- .artifacts_eslint: {
4
- paths: [ "node_modules/" ],
5
- expire_in: 5 minutes
6
- }
7
-
8
- .artifacts_test: {
9
- paths: [ "node_modules/", ".docs/" ],
10
- expire_in: 5 minutes
11
- }
12
-
13
- .deploy_config: {
14
- refs: [ "master", "beta", "/([0-9]+).x/"]
15
- }
16
-
17
- .artifacts_env: {
18
- reports: {
19
- dotenv: build.env
20
- }
21
- }
22
-
23
- .try_publish: {
24
- TRY_PUBLISH: "true"
25
- }
26
-
package/build.env DELETED
File without changes
package/publish-docs.sh DELETED
@@ -1,11 +0,0 @@
1
- #!/bin/bash
2
- if [ "$SONAR_CHECK_ALL" != "true" ] && [ -n "$PUBLISHED_NEXT_VERSION" ]; then
3
- cd ./.docs
4
- npm config set //registry.npmjs.org/:_authToken $NPM_TOKEN
5
- npm version $PUBLISHED_NEXT_VERSION
6
- npm publish
7
- else
8
- echo "A publicação dos docs não foi executada."
9
- echo "SONAR_CHECK_ALL=$SONAR_CHECK_ALL"
10
- echo "PUBLISHED_NEXT_VERSION=$PUBLISHED_NEXT_VERSION"
11
- fi