{"id":21055151,"url":"https://github.com/vtex/typescript","last_synced_at":"2025-05-15T23:32:20.416Z","repository":{"id":39879998,"uuid":"233677406","full_name":"vtex/typescript","owner":"vtex","description":"VTEX's TypeScript tools, style guide and best practices","archived":false,"fork":false,"pushed_at":"2024-08-01T17:37:23.000Z","size":1990,"stargazers_count":55,"open_issues_count":23,"forks_count":7,"subscribers_count":111,"default_branch":"main","last_synced_at":"2025-05-08T19:29:49.638Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-01-13T19:36:30.000Z","updated_at":"2024-09-22T19:31:30.000Z","dependencies_parsed_at":"2024-04-26T20:24:42.768Z","dependency_job_id":"e16d0582-2a91-4ffc-b882-77d3e58c96d8","html_url":"https://github.com/vtex/typescript","commit_stats":null,"previous_names":[],"tags_count":160,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Ftypescript","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Ftypescript/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Ftypescript/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtex%2Ftypescript/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtex","download_url":"https://codeload.github.com/vtex/typescript/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254253957,"owners_count":22039797,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-19T16:36:06.882Z","updated_at":"2025-05-15T23:32:15.349Z","avatar_url":"https://github.com/vtex.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Typescript Standards\n\nMain repository for VTEX's Typescript standards. Issues should be used to start discussions about standards and patterns. PRs are welcome after being rightfully discussed.\n\n## Content\n\n##### `docs/`\n\n- [Style Guide](/docs/Style%20Guide.md) - VTEX Javascript/Typescript style guide\n- [Getting Started](/docs/Getting%20Started.md) - Getting starting guide to configure and automate our tooling process\n- [Browser Support](/docs/Browser%20Support.md) - VTEX browser support documentation\n\n##### `packages/`\n\n- [eslint-config-vtex](/packages/eslint-config-vtex) - base eslint rule preset\n- [eslint-config-vtex-react](/packages/eslint-config-vtex-react) - eslint rule preset for react projects\n- [eslint-plugin-vtex](/packages/eslint-plugin-vtex) - eslint plugin with VTEX custom rules\n- [prettier-config](/packages/prettier-config) - prettier preset of all front-end projects\n- [tsconfig](/packages/tsconfig) - base tsconfig for all typescript projects\n\n## Add these packages to a new project\n\n### Bootstrap on a new node and typescript project\n\n\u003e If you're not using Bash, change `/bin/bash` to your shell's executable path.\n\n```bash\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/vtex/typescript/master/scripts/bootstrap-typescript.sh)\"\n```\n\n\u003e **Warning**: This will **override** the following configuration files: `.prettierrc`, `.eslintrc` and `tsconfig.json`. \n \n## Contributing\n\nNothing is written in stone, so if there's some kind of rule or pattern that you wish to discuss or implement, we encourage an open discussion via this [repository issues](/issues). The project use labels to keep everything organized and easy-to-find:\n\n- `discussion` - discussion thread;\n- `style` - related to code style, something that there's no wrong or right;\n- `practices/patterns` - related to good coding practices that should be standardized and documented;\n- `documentation` - a generic documentation issue;\n- `todo` - common TODO item, with no explicit SLA.\n\nFeel free to use more than one label in an issue, but try keeping them semantic to help developers.\n\n### Working with the packages\n\nThis project uses `lerna` with `yarn` workspaces, so it's highly recommended to read at least the [Lerna documentation](https://github.com/lerna/lerna).\n\n#### Bootstrap the repository\n\nRunning `yarn` will automatically install all the dependencies for all packages and link them together when needed.\n\n```bash\nyarn\n```\n\n#### Executing commands\n\nTo run a `package.json` script on all packages, you can use:\n\n```bash\nlerna run {scriptName}\n# will run the scriptName script on all package directories\n```\n\nIf you want to only run on some packages, pass a `--scope=package-name` to the command above. For more instructions, see the [`lerna run` documentation](https://github.com/lerna/lerna/tree/master/commands/run#readme).\n\n```bash\nlerna run --scope=\"eslint-*\" test\n# run the test script on all packages that match the pattern above\n```\n\nThe same can be done for regular shell programs with the `lerna exec` command:\n\n```bash\nlerna exec \"pwd\"\n# will print the pwd of all package directories\n```\n\n_Note: The quotes are not needed if your command doesn't have a string with spaces._\n\n#### Releasing new versions\n\nFor every release, there should be at least one new changelog entry for every modified package. This repository follows the [keep a changelog](https://keepachangelog.com/en/1.0.0/) format. The [`chan`](https://github.com/geut/chan) CLI can be used to help adding changelog entries:\n\n```bash\nchan fixed \"Fix that nasty potato bug\"\n```\n\nIt's also possible to run the command on multiple packages with the `lerna exec` command:\n\n```bash\nlerna exec \"chan fixed 'Fix that nasty potato bug'\"\n# note the quotes\n```\n\nEvery package has a `version` script that will automatically update their changelog with the new version and entries whenever `lerna publish` or `lerna version` is used.\n\nRelevant commands:\n\n- [`lerna version`](https://github.com/lerna/lerna/blob/master/commands/version/README.md) - Only update versions without publishing the packages.\n- [`lerna publish`](https://github.com/lerna/lerna/blob/master/commands/publish/README.md) - Update the version and publish the packages.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Ftypescript","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtex%2Ftypescript","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtex%2Ftypescript/lists"}