Renomeia a pasta build/tokens para built-tokens #22
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gabrielguilhoto
commented
Aug 24, 2023
| @@ -18,7 +18,7 @@ | |||
| }, | |||
| "ts": { | |||
| "transformGroup": "custom/js", | |||
| "buildPath": "build/tokens/ts/", | |||
| "buildPath": "built-tokens/js/", | |||
There was a problem hiding this comment.
Como após o processo de build do TS (num próximo commit) essa pasta vai ter arquivos JS optei por chamar ela mais genericamente de js em vez de ts.
leocpadua7
approved these changes
Aug 24, 2023
gabrielguilhoto
added a commit
that referenced
this pull request
Aug 28, 2023
# Contexto Ao tentar usar os presets de tipografia no `SGLearner`, tive um erro de TypeScript que poderia ser resolvido pela adição de um `as const` na declaração dos presets. No entanto, isso provocava um outro erro: ``` ERROR in ../node_modules/geekie-design-system/token-presets/basic.ts 30:2 Module parse failed: Unexpected token (30:2) You may need an appropriate loader to handle this file type. | letterSpacing: DSA_LETTER_SPACING_WIDE, | lineHeight: DSA_LINE_HEIGHT_XL, > } as const; ``` A sintaxe do TypeScript não era reconhecida dentro de um node module. Imagino que seria possível configurar para que fosse, mas aparentemente a prática mais comum é de transpilar os arquivos `.ts` para arquivos `.js` + declarações de tipos `.d.ts` (vide microsoft/TypeScript#12358). Dessa forma também é possível usar a lib em contextos não TS, o que devemos precisar por exemplo no Tamojunto. # Mudanças Fiz a configuração para que aconteça a transpilação de arquivos `.ts` para `.js` + `.d.ts`. Foi necessário: * Fazer com que o `tsc` seja rodado no `prepare` do `package.json`, para gerar os arquivos antes de a lib ser usada. * Determinar onde esses arquivos seriam gerados. O padrão seria de eles ficarem no mesmo local dos arquivos originais, mas isso deixaria o repositório desorganizado, então escolhemos deixá-los na pasta `build`. Para isso foi necessário renomear a `build` pré-existente, no PR #22. Discussão relacionada: https://geekie.slack.com/archives/C0547M0UDHR/p1692826665431029 * Alterar como era feito o import de tokens e presets. Antes eles eram da forma `import { ... } from 'geekie-design-system/tokens'`, mas a existência da pasta `build` exigiria que ficassem da forma `import { ... } from 'geekie-design-system/build/tokens'`. Acredito que esse não seria um bom caminho, pois exporia um detalhe de implementação (a existência da pasta `build`) para quem usa a lib. Optamos então por mudar os imports para serem na linha `import { ... } from 'geekie-design-system'`. Esse import na raiz é passível de ser configurado para olhar a pasta build, pelo campo `main` do `package.json`. A mudança do `as const` em si, para evitar os erros de TS nos usos dos presets, virá num outro PR (o #24). # Como testar * Rodar `yarn tsc` e ver que os arquivos `.js` e `.d.ts` são gerados na pasta `build` * Adicionar a lib com as mudanças num projeto (por exemplo o SGLearner) e ver que é possível importar os tokens e presets
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contexto
Atualmente a lib do design system exporta código em TypeScript diretamente. Em vez disso, vamos passar a exportar arquivos
.jsed.tsgerados a partir dos.ts. Uma possibilidade seria deixar esses arquivos.jsed.tsna pastabuild, mas um entrave é o fato de que abuildexistente também tem arquivos.tsa serem processados. Mantendo ela como está, geraríamos uma estrutura confusa, com uma segunda pastabuilddentro dabuildatual. Mais contexto em https://geekie.slack.com/archives/C0547M0UDHR/p1692886284360879.Mudanças
Para evitar a build-ception, optei por renomear a pasta
buildexistente parabuilt-tokens(e as referências a ela de acordo). Provavelmente os arquivos.jse.d.tsvão passar a ficar nabuild, num commit por vir.Como testar
yarn build-tokenseyarn storybooke vi que o Storybook continua se comportando como antes