Improve monorepo setup and tooling #93
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| '@commercetools/history-sdk': minor | ||
| '@commercetools/importapi-sdk': minor | ||
| '@commercetools/ml-sdk': minor | ||
| '@commercetools/platform-sdk': minor | ||
| --- | ||
|
|
||
| Update development tooling and monorepo setup. |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| #!/bin/sh | ||
| . "$(dirname "$0")/_/husky.sh" | ||
|
|
||
| yarn commitlint --edit $1 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| #!/bin/sh | ||
| . "$(dirname "$0")/_/husky.sh" | ||
|
|
||
| yarn lint-staged |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 14 |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| CHANGELOG.md |
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| # Contributing | ||
|
|
||
| Hi, thanks for taking an interest in contributing to the **TypeScript SDK** repository. We welcome any kind of contribution, from reporting issues or idea to submitting pull requests for bug fixes, improvements, new features, etc. | ||
|
|
||
| Please take a moment to review this document in order to make the contribution process straightforward and effective for everyone involved. | ||
|
|
||
| ## Core ideas | ||
|
|
||
| The repository primarily contains SDK packages in TypeScript generated from the commercetools platform API reference. | ||
|
|
||
| ## Repository structure | ||
|
|
||
| This repository is managed as a monorepo, meaning it contains multiple (sub)packages located in the [`packages`](./packages) directory. | ||
|
|
||
| ``` | ||
| packages/ | ||
| ... | ||
| ``` | ||
|
|
||
| ### Development tools | ||
|
|
||
| At commercetools we use the following development tools: | ||
|
|
||
| #### Yarn | ||
|
|
||
| We use [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/) to manage dependencies between multiple packages. | ||
|
|
||
| #### Jest | ||
|
|
||
| We use [Jest](https://jestjs.io/) as the main framework for testing. Additionally, we take advantage of the Jest runners to run other tasks such as ESLint. | ||
|
|
||
| #### Prettier | ||
|
|
||
| We rely on [Prettier](https://prettier.io/) to consistently format our code. | ||
|
|
||
| #### TypeScript | ||
|
|
||
| We prefer to implement our UI components using [TypeScript](https://www.typescriptlang.org/). This has the benefit of provide packages with type declarations, thus a better developer experience, but also to have the codebase more maintainable and less error-prone. | ||
|
|
||
| #### Preconstruct | ||
|
|
||
| We rely on [Preconstruct](https://preconstruct.tools/) to build the packages. | ||
|
|
||
| #### Commitlint | ||
|
|
||
| Commit messages should follow a [conventional commit format](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional). | ||
|
|
||
| ## Opening an Issue | ||
|
|
||
| In general, it's a good idea to open an issue first, no matter if it's a bug report, a new feature, etc. Doing so allows maintainers and other contributors to be aware of the context when an associated pull request is provided. It also gives a chance to provide early feedback and suggestions on what the pull request should focus on and what the expectations, avoiding unnecessary work during a pull request. | ||
|
|
||
| ## Submitting a Pull Request | ||
|
|
||
| Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. | ||
|
|
||
| If possible, please try to provide a [related issue first](#opening-an-issue), where the topic is discussed and agreed upon before starting to work on that. This is helpful for both you and the maintainers to be familiar with the changes beforehand. | ||
|
|
||
| ## Getting started | ||
|
|
||
| 1. Clone the repository. | ||
| 2. Run `yarn` in the root folder to install the dependencies. | ||
|
|
||
| Some useful commands to work with the repository: | ||
|
|
||
| - `yarn test` and `yarn test --watch` | ||
| - `yarn typecheck` | ||
| - `yarn build` | ||
|
|
||
| ## Adding changesets | ||
|
|
||
| commercetools sdk-typescript uses [changesets](https://github.com/atlassian/changesets) to do versioning and creating changelogs. | ||
|
|
||
| As a contributor you need to add a changeset by running `yarn changeset`. | ||
| The command will prompt to select the packages that should be bumped, their associated semver bump types and some markdown which will be inserted into the changelogs. | ||
|
|
||
| When opening a Pull Request, a `changeset-bot` checks that the Pull Request contains a changeset. A changeset is **NOT required**, as things like documentation or other changes in the repository itself generally don't need a changeset. | ||
|
|
||
| ## Releasing packages | ||
|
|
||
| commercetools sdk-typescript uses [changesets](https://github.com/atlassian/changesets) to do versioning and publishing a release. | ||
|
|
||
| A [Changesets release GitHub Action](https://github.com/changesets/action) opens a `Version Packages` Pull Request whenever there are some changesets that have not been released yet. | ||
|
|
||
| When the `Version Packages` Pull Request gets merged, the Changesets release GitHub Action will automatically trigger the release. |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| /** | ||
| * @type {import('@babel/core').TransformOptions} | ||
| */ | ||
| module.exports = { | ||
| presets: ['@babel/env', '@babel/preset-typescript'], | ||
| plugins: ['@babel/proposal-class-properties'], | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,14 @@ | ||
| /* eslint-disable */ | ||
| module.exports = { | ||
| extends: ['@commitlint/config-conventional'], | ||
| parserPreset: { | ||
| parserOpts: { | ||
| // Allow to write a "scope" with slashes | ||
| // E.g. `refactor(app/my-component): something` | ||
| headerPattern: /^(\w*)(?:\(([\w\$\.\/\-\* ]*)\))?\: (.*)$/, | ||
| }, | ||
| }, | ||
| rules: { | ||
| 'header-max-length': [0, 'always', 100], | ||
| }, | ||
| } |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| /** | ||
| * @type {import('@jest/types').Config.ProjectConfig} | ||
| */ | ||
| module.exports = { | ||
| preset: 'ts-jest', | ||
| testEnvironment: 'node', | ||
| transform: { | ||
| '^.+\\.js$': 'babel-jest', | ||
| '^.+\\.tsx?$': 'ts-jest', | ||
| }, | ||
| testRegex: '\\.(test|spec)\\.[j|t]sx?$', | ||
| moduleFileExtensions: ['ts', 'js', 'json'], | ||
| watchPlugins: ['jest-watch-typeahead/filename'], | ||
| reporters: [ | ||
| 'default', | ||
| process.env.CI === 'true' | ||
| ? [ | ||
| 'jest-junit', | ||
| { outputName: 'results.xml', outputDirectory: 'test-results' }, | ||
| ] | ||
|
Comment on lines
+17
to
+20
There was a problem hiding this comment. Do you know why are we using and storing test results as artifacts? Are they used somewhere? There was a problem hiding this comment. Not really, but I will also look into it. |
||
| : null, | ||
| ].filter(Boolean), | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,48 @@ | ||
| { | ||
| "name": "commercetools-sdk-typescript", | ||
| "private": true, | ||
| "scripts": { | ||
| "prepare": "husky install", | ||
| "postinstall": "manypkg check && preconstruct dev", | ||
| "generate": "manypkg run generate && yarn format", | ||
| "format": "prettier --write '**/*.{js,ts,json,md}'", | ||
| "build": "preconstruct build", | ||
| "test": "jest --maxWorkers=2", | ||
| "typecheck": "tsc --noEmit", | ||
| "changeset": "changeset", | ||
| "changeset:version-and-format": "changeset version && prettier --write --parser json '**/package.json'" | ||
| }, | ||
| "workspaces": ["packages/*"], | ||
| "dependencies": { | ||
| "@babel/core": "7.15.0", | ||
| "@babel/plugin-proposal-class-properties": "7.14.5", | ||
| "@babel/preset-env": "7.15.0", | ||
| "@babel/preset-typescript": "7.15.0", | ||
| "@changesets/changelog-github": "0.4.0", | ||
| "@changesets/cli": "2.16.0", | ||
| "@commitlint/cli": "13.1.0", | ||
| "@commitlint/config-conventional": "13.1.0", | ||
| "@manypkg/cli": "0.18.0", | ||
| "@preconstruct/cli": "2.1.0", | ||
| "@types/jest": "27.0.0", | ||
| "@types/node": "14.14.31", | ||
| "babel-jest": "27.0.6", | ||
| "husky": "7.0.1", | ||
| "jest": "27.0.6", | ||
| "jest-junit": "12.2.0", | ||
| "jest-watch-typeahead": "0.6.4", | ||
| "lint-staged": "11.1.2", | ||
| "prettier": "1.19.1", | ||
| "rimraf": "3.0.2", | ||
| "ts-jest": "27.0.4", | ||
| "tsc-files": "1.1.2", | ||
| "typescript": "4.3.5" | ||
| }, | ||
| "lint-staged": { | ||
| "*.{js,json,md}": ["prettier --write"], | ||
| "*.ts": ["prettier --write", "tsc-files --noEmit"] | ||
| }, | ||
| "preconstruct": { | ||
| "packages": ["packages/*"] | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Optimized image for circleci