@sankhyalabs/core-docs 5.6.0 → 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 (4) hide show
  1. package/README.md +39 -33
  2. package/classes/HTMLBuilder.md +45 -0
  3. package/modules.md +1 -0
  4. package/package.json +1 -1
package/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/classes/HTMLBuilder.md ADDED
@@ -0,0 +1,45 @@
1
+ [@sankhyalabs/core](../README.md) / [Exports](../modules.md) / HTMLBuilder
2
+
3
+ # Class: HTMLBuilder
4
+
5
+ ## Table of contents
6
+
7
+ ### Constructors
8
+
9
+ - [constructor](HTMLBuilder.md#constructor)
10
+
11
+ ### Methods
12
+
13
+ - [parseElement](HTMLBuilder.md#parseelement)
14
+
15
+ ## Constructors
16
+
17
+ ### constructor
18
+
19
+ • **new HTMLBuilder**()
20
+
21
+ ## Methods
22
+
23
+ ### parseElement
24
+
25
+ ▸ `Static` **parseElement**<`ElementType`\>(`html`): `ElementType`
26
+
27
+ #### Type parameters
28
+
29
+ | Name | Type |
30
+ | :------ | :------ |
31
+ | `ElementType` | extends `HTMLElement`<`ElementType`\> |
32
+
33
+ #### Parameters
34
+
35
+ | Name | Type |
36
+ | :------ | :------ |
37
+ | `html` | `string` |
38
+
39
+ #### Returns
40
+
41
+ `ElementType`
42
+
43
+ #### Defined in
44
+
45
+ src/html/HTMLBuilder.ts:2
package/modules.md CHANGED
@@ -32,6 +32,7 @@
32
32
  - [ErrorException](classes/ErrorException.md)
33
33
  - [ErrorTracking](classes/ErrorTracking.md)
34
34
  - [FloatingManager](classes/FloatingManager.md)
35
+ - [HTMLBuilder](classes/HTMLBuilder.md)
35
36
  - [HttpProvider](classes/HttpProvider.md)
36
37
  - [JSUtils](classes/JSUtils.md)
37
38
  - [MaskFormatter](classes/MaskFormatter-1.md)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sankhyalabs/core-docs",
3
- "version": "5.6.0",
3
+ "version": "5.8.0",
4
4
  "description": "Documentação da biblioteca de componentes Sankhya.",
5
5
  "main": "",
6
6
  "files": [