From 4b9786d162f9580c06c157b3d10863ee7667d324 Mon Sep 17 00:00:00 2001 From: Yagiz Nizipli Date: Thu, 28 Dec 2023 10:23:56 -0500 Subject: [PATCH] fix: enables prettier for markdown and css --- .vscode/extensions.json | 1 + .vscode/settings.json | 6 + docs/event-sending.md | 160 +++++++++--------- docs/gitflow.md | 11 +- docs/new-sdk-release-checklist.md | 140 ++++++++------- docs/publishing-a-release.md | 24 ++- docs/using-yalc.md | 14 +- package.json | 16 +- packages/ember/tests/dummy/app/styles/app.css | 10 +- yarn.lock | 5 + 10 files changed, 226 insertions(+), 161 deletions(-) diff --git a/.vscode/extensions.json b/.vscode/extensions.json index cf9ee54f8ea5..9b4a2aa7eb87 100644 --- a/.vscode/extensions.json +++ b/.vscode/extensions.json @@ -2,6 +2,7 @@ // See http://go.microsoft.com/fwlink/?LinkId=827846 // for the documentation about the extensions.json format "recommendations": [ + "esbenp.prettier-vscode", "biomejs.biome", "dbaeumer.vscode-eslint", "augustocdias.tasks-shell-input", diff --git a/.vscode/settings.json b/.vscode/settings.json index 7835767bad18..d357aece1dd9 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -20,6 +20,12 @@ "editor.formatOnPaste": false, "editor.formatOnSave": false }, + "[markdown]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, + "[css]": { + "editor.defaultFormatter": "esbenp.prettier-vscode" + }, "yaml.schemas": { "https://json.schemastore.org/github-workflow.json": ".github/workflows/**.yml" }, diff --git a/docs/event-sending.md b/docs/event-sending.md index f014e1f2f94e..894da827508b 100644 --- a/docs/event-sending.md +++ b/docs/event-sending.md @@ -4,95 +4,95 @@ This document gives an outline for how event sending works, and which which plac ## Errors -* `hub.captureException()` - * `client.captureException()` (see baseclient) - * `checkOrSetAlreadyCaught()` - * `baseclient._process()` - * `baseclient.eventFromException()` - * `baseclient._captureEvent()` - * `baseclient._processEvent()` - * `baseclient._prepareEvent()` - * `baseclient._applyClientOptions()` - * `baseclient._applyIntegrationsMetadata()` - * `scope.applyToEvent()` - * `baseclient._normalizeEvent()` - * `baseclient._updateSessionFromEvent()` - * `baseclient.sendEvent()` - * `createEventEnvelope()` - * `getSdkMetadataForEnvelopeHeader()` - * `enhanceEventWithSdkInfo()` - * `createEventEnvelopeHeaders()` - * `createEnvelope()` - * `addItemToEnvelope()` - * `createAttachmentEnvelopeItem()` - * `baseclient._sendEnvelope()` - * `transport.send()` +- `hub.captureException()` + - `client.captureException()` (see baseclient) + - `checkOrSetAlreadyCaught()` + - `baseclient._process()` + - `baseclient.eventFromException()` + - `baseclient._captureEvent()` + - `baseclient._processEvent()` + - `baseclient._prepareEvent()` + - `baseclient._applyClientOptions()` + - `baseclient._applyIntegrationsMetadata()` + - `scope.applyToEvent()` + - `baseclient._normalizeEvent()` + - `baseclient._updateSessionFromEvent()` + - `baseclient.sendEvent()` + - `createEventEnvelope()` + - `getSdkMetadataForEnvelopeHeader()` + - `enhanceEventWithSdkInfo()` + - `createEventEnvelopeHeaders()` + - `createEnvelope()` + - `addItemToEnvelope()` + - `createAttachmentEnvelopeItem()` + - `baseclient._sendEnvelope()` + - `transport.send()` ## Transactions -* `transaction.finish()` - * `transaction.getTraceContext()` - * `transaction.getDynamicSamplingContext()` - * `hub.captureEvent()` - * `client.captureEvent()` (see baseclient) - * `checkOrSetAlreadyCaught()` - * `baseclient._process()` - * `baseclient.eventFromException()` - * `baseclient._captureEvent()` - * `baseclient._processEvent()` - * `baseclient._prepareEvent()` - * `baseclient._applyClientOptions()` - * `baseclient._applyIntegrationsMetadata()` - * `scope.applyToEvent()` - * `baseclient._normalizeEvent()` - * `baseclient._updateSessionFromEvent()` - * `baseclient.sendEvent()` - * `createEventEnvelope()` - * `getSdkMetadataForEnvelopeHeader()` - * `enhanceEventWithSdkInfo()` - * `createEventEnvelopeHeaders()` - * `createEnvelope()` - * `addItemToEnvelope()` - * `createAttachmentEnvelopeItem()` - * `baseclient._sendEnvelope()` - * `transport.send()` +- `transaction.finish()` + - `transaction.getTraceContext()` + - `transaction.getDynamicSamplingContext()` + - `hub.captureEvent()` + - `client.captureEvent()` (see baseclient) + - `checkOrSetAlreadyCaught()` + - `baseclient._process()` + - `baseclient.eventFromException()` + - `baseclient._captureEvent()` + - `baseclient._processEvent()` + - `baseclient._prepareEvent()` + - `baseclient._applyClientOptions()` + - `baseclient._applyIntegrationsMetadata()` + - `scope.applyToEvent()` + - `baseclient._normalizeEvent()` + - `baseclient._updateSessionFromEvent()` + - `baseclient.sendEvent()` + - `createEventEnvelope()` + - `getSdkMetadataForEnvelopeHeader()` + - `enhanceEventWithSdkInfo()` + - `createEventEnvelopeHeaders()` + - `createEnvelope()` + - `addItemToEnvelope()` + - `createAttachmentEnvelopeItem()` + - `baseclient._sendEnvelope()` + - `transport.send()` ## Sessions -* `hub.captureSession()` - * `hub.endSession()` - * `closeSession()` - * `hub._sendSessionUpdate()` - * `scope.setSession()` - * `hub._sendSessionUpdate()` - * `client.captureSession()` (see baseclient) - * `baseclient.sendSession()` - * `createSessionEnvelope()` - * `getSdkMetadataForEnvelopeHeader()` - * `createEnvelope()` - * `baseclient._sendEnvelope()` - * `transport.send()` - * `updateSession()` +- `hub.captureSession()` + - `hub.endSession()` + - `closeSession()` + - `hub._sendSessionUpdate()` + - `scope.setSession()` + - `hub._sendSessionUpdate()` + - `client.captureSession()` (see baseclient) + - `baseclient.sendSession()` + - `createSessionEnvelope()` + - `getSdkMetadataForEnvelopeHeader()` + - `createEnvelope()` + - `baseclient._sendEnvelope()` + - `transport.send()` + - `updateSession()` ## Replay (WIP) -* `replay.sendReplayRequest()` - * `createRecordingData()` - * `prepareReplayEvent()` - * `client._prepareEvent()` (see baseclient) - * `baseclient._applyClientOptions()` - * `baseclient._applyIntegrationsMetadata()` - * `scope.applyToEvent()` - * `baseclient._normalizeEvent()` - * `createReplayEnvelope()` - * `createEnvelope()` - * `transport.send()` +- `replay.sendReplayRequest()` + - `createRecordingData()` + - `prepareReplayEvent()` + - `client._prepareEvent()` (see baseclient) + - `baseclient._applyClientOptions()` + - `baseclient._applyIntegrationsMetadata()` + - `scope.applyToEvent()` + - `baseclient._normalizeEvent()` + - `createReplayEnvelope()` + - `createEnvelope()` + - `transport.send()` ## Client Reports -* `browser.client.constructor()` - * `browser.client._flushOutcomes()` - * `getEnvelopeEndpointWithUrlEncodedAuth()` - * `createClientReportEnvelope()` - * `baseclient._sendEnvelope()` - * `transport.send()` +- `browser.client.constructor()` + - `browser.client._flushOutcomes()` + - `getEnvelopeEndpointWithUrlEncodedAuth()` + - `createClientReportEnvelope()` + - `baseclient._sendEnvelope()` + - `transport.send()` diff --git a/docs/gitflow.md b/docs/gitflow.md index 91ac1cef1186..aa1927384d73 100644 --- a/docs/gitflow.md +++ b/docs/gitflow.md @@ -4,10 +4,11 @@ We use [Gitflow](https://docs.github.com/en/get-started/quickstart/github-flow) ## Summary -* Ongoing work happens on the `develop` branch -* Any PRs (features, ...) are implemented as PRs against `develop` -* When we are ready to release, we merge develop into master, create a release there, then merge master back into develop -* Whatever is currently on `master` can be considered the last released state of the SDK -* Never merge directly into `master` (unless we want e.g. an emergency bugfix release) +- Ongoing work happens on the `develop` branch +- Any PRs (features, ...) are implemented as PRs against `develop` +- When we are ready to release, we merge develop into master, create a release there, then merge master back into + develop +- Whatever is currently on `master` can be considered the last released state of the SDK +- Never merge directly into `master` (unless we want e.g. an emergency bugfix release) ![gitflow-chart](./assets/gitflow-chart.png) diff --git a/docs/new-sdk-release-checklist.md b/docs/new-sdk-release-checklist.md index fc7cd8be3edf..ffb101ede0fa 100644 --- a/docs/new-sdk-release-checklist.md +++ b/docs/new-sdk-release-checklist.md @@ -2,88 +2,114 @@ This page serves as a checklist of what to do when releasing a new SDK for the first time. -*This checklist was written while working on the `@sentry/svelte` Alpha 1 release. Some parts in this checklist might differ slightly for other SDKs depending on how they are structured and how they work* +_This checklist was written while working on the `@sentry/svelte` Alpha 1 release. Some parts in this checklist might +differ slightly for other SDKs depending on how they are structured and how they work_ ## Release Preparation: -- [ ] Make sure, the project is set up completely - - [ ] The package exports the necessary modules - - [ ] The package has a working unit testing environment - - [ ] The package builds correctly (inspect `/build` directory) +- [ ] Make sure, the project is set up completely -- [ ] Make sure that the `README.md` content is up to date and contains at least: - - [ ] The correct name + a brief description of the SDK - - [ ] Badges pointing to the correct (yet not existing) NPM package *(this isn’t deadly necessary but nice to have)* - - [ ] If the SDK is not yet stable, a clear message indicating that it is in alpha/beta state and that breaking changes can still occur - - [ ] A brief description how to set up and configure the SDK. If you already have docs, add a link to the docs, otherwise link to the “parent” SDK docs (e.g. `@sentry/browser`) if applicable - - [ ] Extra information (e.g. how to upload sourcemaps) + - [ ] The package exports the necessary modules + - [ ] The package has a working unit testing environment + - [ ] The package builds correctly (inspect `/build` directory) -- [ ] Make sure that the `LICENSE` file exists and has the correct license (We default to the `MIT` license) - - [ ] Also check, that the same license is mentioned in `package.json` +- [ ] Make sure that the `README.md` content is up to date and contains at least: -- [ ] Make sure that the tarball (`yarn build:tarball`) has all the necessary contents + - [ ] The correct name + a brief description of the SDK + - [ ] Badges pointing to the correct (yet not existing) NPM package _(this isn’t deadly necessary but nice to have)_ + - [ ] If the SDK is not yet stable, a clear message indicating that it is in alpha/beta state and that breaking + changes can still occur + - [ ] A brief description how to set up and configure the SDK. If you already have docs, add a link to the docs, + otherwise link to the “parent” SDK docs (e.g. `@sentry/browser`) if applicable + - [ ] Extra information (e.g. how to upload sourcemaps) - For basic SDKs, this means that the tarball has at least these files: +- [ ] Make sure that the `LICENSE` file exists and has the correct license (We default to the `MIT` license) - - [ ] `cjs/.js` - - [ ] `esm/.js` - - [ ] `types/` - - [ ] `package.json` - - [ ] Entry points registered in this file match the file structure above - - [ ] `LICENSE` - - [ ] `README.md` - - [ ] If your tarball should contain additional files outside `esm`, `cjs`, and `types` that are not listed above (e.g. like Gatsby or Remix), be sure to add a package-specific `prepack.ts` script. In this script, you can copy these additional files and make other adjustments.\ - Check out the [Gatsby script](https://github.com/getsentry/sentry-javascript/blob/acd7fbb56ed1859ce48f06a76143075108631c25/packages/gatsby/scripts/prepack.ts#L1) as an example.\ - It’s recommended to build and pack a tarball and then `yarn add path/to/tarball.tar.gz` it to your test app(s) to ensure that it has all the correct files. + - [ ] Also check, that the same license is mentioned in `package.json` -- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package - - [ ] Ensure dependent packages are correctly set for “Determine changed packages” - - [ ] Ensure unit tests run correctly +- [ ] Make sure that the tarball (`yarn build:tarball`) has all the necessary contents -- [ ] Make sure the file paths in the ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349) in `build.yml` include your new artifacts. - - **This is especially important, if you're adding new CDN bundles!** - - Tarballs (*.tgz archives) should work OOTB + For basic SDKs, this means that the tarball has at least these files: + - [ ] `cjs/.js` + - [ ] `esm/.js` + - [ ] `types/` + - [ ] `package.json` + - [ ] Entry points registered in this file match the file structure above + - [ ] `LICENSE` + - [ ] `README.md` + - [ ] If your tarball should contain additional files outside `esm`, `cjs`, and `types` that are not listed above + (e.g. like Gatsby or Remix), be sure to add a package-specific `prepack.ts` script. In this script, you can copy + these additional files and make other adjustments.\ + Check out the + [Gatsby script](https://github.com/getsentry/sentry-javascript/blob/acd7fbb56ed1859ce48f06a76143075108631c25/packages/gatsby/scripts/prepack.ts#L1) + as an example.\ + It’s recommended to build and pack a tarball and then `yarn add path/to/tarball.tar.gz` it to your test app(s) + to ensure that it has all the correct files. -- [ ] Make sure it is added to `bundlePlugins.ts:makeTSPlugin` as `paths`, otherwise it will not be ES5 transpiled correctly for CDN builds. +- [ ] Make sure `build.yml` CI script is correctly set up to cover tests for the new package -- [ ] Make sure it is added to the [Verdaccio config](https://github.com/getsentry/sentry-javascript/blob/develop/packages/e2e-tests/verdaccio-config/config.yaml) for the E2E tests + - [ ] Ensure dependent packages are correctly set for “Determine changed packages” + - [ ] Ensure unit tests run correctly -- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that your package is added to the integration test apps' `"resolutions"` field in their `package.json`s. +- [ ] Make sure the file paths in the + ["Upload Artifacts" job](https://github.com/getsentry/sentry-javascript/blob/e5c1486eed236b878f2c49d6a04be86093816ac9/.github/workflows/build.yml#L314-L349) + in `build.yml` include your new artifacts. + + - **This is especially important, if you're adding new CDN bundles!** + - Tarballs (\*.tgz archives) should work OOTB + +- [ ] Make sure it is added to `bundlePlugins.ts:makeTSPlugin` as `paths`, otherwise it will not be ES5 transpiled + correctly for CDN builds. + +- [ ] Make sure it is added to the + [Verdaccio config](https://github.com/getsentry/sentry-javascript/blob/develop/packages/e2e-tests/verdaccio-config/config.yaml) + for the E2E tests + +- [ ] If the package you're adding is a dependency of fullstack framework (e.g. Remix or NextJS) SDKs, make sure that + your package is added to the integration test apps' `"resolutions"` field in their `package.json`s. ## Cutting the Release -When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct order**. Note that you can prepare the PRs at any time but the **merging oder** is important: +When you’re ready to make the first release, there are a couple of steps that need to be performed in the **correct +order**. Note that you can prepare the PRs at any time but the **merging oder** is important: -**All of these steps should happen when you’re committed to releasing the SDK in the *next upcoming* release**. +**All of these steps should happen when you’re committed to releasing the SDK in the _next upcoming_ release**. ### Before the Release: -- [ ] 1) If not yet done, be sure to remove the `private: true` property from your SDK’s `package.json`. Additionally, ensure that `"publishConfig": {"access": "public"}` is set. -- [ ] 2) Make sure that the new SDK is **not added** in`[craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml)` as a target for the **Sentry release registry**\ -*Once this is added, craft will try to publish an entry in the next release which does not work and caused failed release runs in the past* -- [ ] 3) Add an `npm` target in `craft.yml` for the new package. Make sure to insert it in the right place, after all the Sentry dependencies of your package but before packages that depend on your new package (if applicable). - ```yml - - name: npm - id: '@sentry/[yourPackage]' - includeNames: /^sentry-[yourPackage]-\d.*\.tgz$/ - ``` -- [ ] 4) Cut a new release (as usual, see [Publishing Release](https://github.com/getsentry/sentry-javascript/blob/develop/docs/publishing-a-release.md)) +- [ ] 1. If not yet done, be sure to remove the `private: true` property from your SDK’s `package.json`. Additionally, + ensure that `"publishConfig": {"access": "public"}` is set. +- [ ] 2. Make sure that the new SDK is **not added** + in`[craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml)` as a target for the + **Sentry release registry**\ + _Once this is added, craft will try to publish an entry in the next release which does not work and caused failed release + runs in the past_ +- [ ] 3. Add an `npm` target in `craft.yml` for the new package. Make sure to insert it in the right place, after all + the Sentry dependencies of your package but before packages that depend on your new package (if applicable). + ```yml + - name: npm + id: '@sentry/[yourPackage]' + includeNames: /^sentry-[yourPackage]-\d.*\.tgz$/ + ``` +- [ ] 4. Cut a new release (as usual, see + [Publishing Release](https://github.com/getsentry/sentry-javascript/blob/develop/docs/publishing-a-release.md)) ### After the Release -- [ ] 4) Check that the package was in fact published to NPM -- [ ] 5) Add the new SDK to the [Sentry Release Registry](https://github.com/getsentry/sentry-release-registry) \ - Instructions on how to do this can be found [here](https://github.com/getsentry/sentry-release-registry#adding-new-sdks) \ - You have to fork this repo and PR the files from your fork to the main repo \ - [Example PR](https://github.com/getsentry/sentry-release-registry/pull/80) from the Svelte SDK - -- [ ] 2) Add an entry to [craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml) to add releases of your SDK to the Sentry release registry \ - [Example PR](https://github.com/getsentry/sentry-javascript/pull/5547) from the Svelte SDK \ - *Subsequent releases will now be added automatically to the registry* +- [ ] 4. Check that the package was in fact published to NPM +- [ ] 5. Add the new SDK to the [Sentry Release Registry](https://github.com/getsentry/sentry-release-registry) \ + Instructions on how to do this can be found [here](https://github.com/getsentry/sentry-release-registry#adding-new-sdks) + \ + You have to fork this repo and PR the files from your fork to the main repo \ + [Example PR](https://github.com/getsentry/sentry-release-registry/pull/80) from the Svelte SDK +- [ ] 2. Add an entry to [craft.yml](https://github.com/getsentry/sentry-javascript/blob/develop/.craft.yml) to add + releases of your SDK to the Sentry release registry \ + [Example PR](https://github.com/getsentry/sentry-javascript/pull/5547) from the Svelte SDK \ + _Subsequent releases will now be added automatically to the registry_ ## Follow-up Tasks -- [ ] Monitor GH for incoming bug reports/feature requests/praises/thank you messages/marriage proposals and potatoes -- [ ] Feel good about yourself 😎 +- [ ] Monitor GH for incoming bug reports/feature requests/praises/thank you messages/marriage proposals and potatoes +- [ ] Feel good about yourself 😎 diff --git a/docs/publishing-a-release.md b/docs/publishing-a-release.md index ff94e6165ea8..ab3044529ddc 100644 --- a/docs/publishing-a-release.md +++ b/docs/publishing-a-release.md @@ -1,25 +1,31 @@ - # Publishing a Release _These steps are only relevant to Sentry employees when preparing and publishing a new SDK release._ -**If you want to release a new SDK for the first time, be sure to follow the [New SDK Release Checklist](./new-sdk-release-checklist.md)** +**If you want to release a new SDK for the first time, be sure to follow the +[New SDK Release Checklist](./new-sdk-release-checklist.md)** 1. Determine what version will be released (we use [semver](https://semver.org)). 2. Create a branch `prepare-release/VERSION`, eg. `prepare-release/7.37.0`, off develop -3. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry for the next release number and a list of changes since the last release. (See details below.) +3. Update [`CHANGELOG.md`](https://github.com/getsentry/sentry-javascript/edit/master/CHANGELOG.md) to add an entry for + the next release number and a list of changes since the last release. (See details below.) 4. Create a PR towards `master` branch -5. When the PR is merged, it will automatically trigger the [Prepare Release](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) on master. +5. When the PR is merged, it will automatically trigger the + [Prepare Release](https://github.com/getsentry/sentry-javascript/actions/workflows/release.yml) on master. 6. A new issue should appear in https://github.com/getsentry/publish/issues. -7. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve the release. - a. Once the release is completed, a sync from `master` ->` develop` will be automatically triggered +7. Ask a member of the [@getsentry/releases team](https://github.com/orgs/getsentry/teams/releases/members) to approve + the release. a. Once the release is completed, a sync from `master` ->` develop` will be automatically triggered ## Updating the Changelog 1. Create a new branch `prepare-release/VERSION` off of `develop`, e.g. `prepare-release/7.37.1`. 2. Run `yarn changelog` and copy everything -3. Create a new section in the changelog, deciding based on the changes whether it should be a minor bump or a patch release. +3. Create a new section in the changelog, deciding based on the changes whether it should be a minor bump or a patch + release. 4. Paste in the logs you copied earlier. 5. Delete any which aren't user-facing changes. -7. If any of the PRs are from external contributors, include underneath the commits `Work in this release contributed by . Thank you for your contributions!`. If there's only one external PR, don't forget to remove the final `s`. If there are three or more, use an Oxford comma. (It's in the Sentry styleguide!) -8. Commit, push, and open a PR with the title `meta(changelog): Update changelog for VERSION` against `master` branch. +6. If any of the PRs are from external contributors, include underneath the commits + `Work in this release contributed by . Thank you for your contributions!`. + If there's only one external PR, don't forget to remove the final `s`. If there are three or more, use an Oxford + comma. (It's in the Sentry styleguide!) +7. Commit, push, and open a PR with the title `meta(changelog): Update changelog for VERSION` against `master` branch. diff --git a/docs/using-yalc.md b/docs/using-yalc.md index f5f4d331ecb1..2a733330f8a2 100644 --- a/docs/using-yalc.md +++ b/docs/using-yalc.md @@ -1,7 +1,8 @@ # Using `yalc` for Local SDK Testing -[Yalc](https://github.com/wclr/yalc) is a simple local dependency repository which we can use to work with local versions of our SDKs. -This is a good alternative to `npm|yarn link` for packages where linking is problematic (e.g. SvelteKit or Angular). +[Yalc](https://github.com/wclr/yalc) is a simple local dependency repository which we can use to work with local +versions of our SDKs. This is a good alternative to `npm|yarn link` for packages where linking is problematic (e.g. +SvelteKit or Angular). Here's how to set up and use yalc: @@ -25,7 +26,9 @@ Whenever you want to make your local changes available to your test projects (e. yarn yalc:publish ``` -If you run this command in the root of the repo, this will publish all SDK packages to the local yalc repo. If you run it in a specific SDK package, it will just publish this package. You **don't need to** call `yalc update` in your test project. Already linked test projects will be update automatically. +If you run this command in the root of the repo, this will publish all SDK packages to the local yalc repo. If you run +it in a specific SDK package, it will just publish this package. You **don't need to** call `yalc update` in your test +project. Already linked test projects will be update automatically. ## Using yalc packages @@ -47,5 +50,6 @@ Did you run `yarn build && yarn yalc:publish` after making your changes? ### My test project uses Vite and I still don't see changes -Vite pre-bundles and caches dependencies for dev builds. It [doesn't recognize changes in yalc packages though](https://github.com/wclr/yalc/issues/189) :( To make these changes show up anyway, run `vite dev --force`. - +Vite pre-bundles and caches dependencies for dev builds. It +[doesn't recognize changes in yalc packages though](https://github.com/wclr/yalc/issues/189) :( To make these changes +show up anyway, run `vite dev --force`. diff --git a/package.json b/package.json index 239ddb58ed84..f33d3c17e14f 100644 --- a/package.json +++ b/package.json @@ -18,14 +18,16 @@ "clean:deps": "lerna clean --yes && rm -rf node_modules && yarn", "clean:all": "run-s clean:build clean:caches clean:deps", "codecov": "codecov", - "fix": "run-p fix:lerna fix:biome", + "fix": "run-p fix:lerna fix:biome fix:prettier", "fix:lerna": "lerna run fix", "fix:biome": "biome check --apply .", + "fix:prettier": "prettier **/*.md **/*.css --write", "changelog": "ts-node ./scripts/get-commit-list.ts", "link:yarn": "lerna exec yarn link", - "lint": "run-p lint:lerna lint:biome", + "lint": "run-p lint:lerna lint:biome lint:prettier", "lint:lerna": "lerna run lint", "lint:biome": "biome check .", + "lint:prettier": "prettier **/*.md **/*.css", "validate:es5": "lerna run validate:es5", "postpublish": "lerna run --stream --concurrency 1 postpublish", "test": "lerna run --ignore \"@sentry-internal/{browser-integration-tests,e2e-tests,integration-shims,node-integration-tests,overhead-metrics}\" test", @@ -116,6 +118,7 @@ "mocha": "^6.1.4", "nodemon": "^2.0.16", "npm-run-all": "^4.1.5", + "prettier": "^3.1.1", "replace-in-file": "^4.0.0", "rimraf": "^3.0.2", "rollup": "^2.67.1", @@ -136,5 +139,12 @@ "**/terser/source-map": "0.7.4" }, "version": "0.0.0", - "name": "sentry-javascript" + "name": "sentry-javascript", + "prettier": { + "arrowParens": "avoid", + "printWidth": 120, + "proseWrap": "always", + "singleQuote": true, + "trailingComma": "all" + } } diff --git a/packages/ember/tests/dummy/app/styles/app.css b/packages/ember/tests/dummy/app/styles/app.css index 4d9686bbd61f..f926764e8b3d 100644 --- a/packages/ember/tests/dummy/app/styles/app.css +++ b/packages/ember/tests/dummy/app/styles/app.css @@ -17,7 +17,11 @@ body { background-repeat: repeat; height: 100%; margin: 0; - font-family: Rubik, Avenir Next, Helvetica Neue, sans-serif; + font-family: + Rubik, + Avenir Next, + Helvetica Neue, + sans-serif; font-size: 16px; line-height: 24px; color: var(--foreground-color); @@ -43,7 +47,9 @@ body { .box { background-color: #fff; border: 0; - box-shadow: 0 0 0 1px rgba(0, 0, 0, 0.08), 0 1px 4px rgba(0, 0, 0, 0.1); + box-shadow: + 0 0 0 1px rgba(0, 0, 0, 0.08), + 0 1px 4px rgba(0, 0, 0, 0.1); border-radius: 4px; display: flex; width: 100%; diff --git a/yarn.lock b/yarn.lock index 42e9c147cc69..57ae0e9f2357 100644 --- a/yarn.lock +++ b/yarn.lock @@ -25720,6 +25720,11 @@ prettier@^2.5.1: resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.7.1.tgz#e235806850d057f97bb08368a4f7d899f7760c64" integrity sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g== +prettier@^3.1.1: + version "3.1.1" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.1.1.tgz#6ba9f23165d690b6cbdaa88cb0807278f7019848" + integrity sha512-22UbSzg8luF4UuZtzgiUOfcGM8s4tjBv6dJRT7j275NXsy2jb4aJa4NNveul5x4eqlF1wuhuR2RElK71RvmVaw== + pretty-bytes@^5.3.0: version "5.6.0" resolved "https://registry.yarnpkg.com/pretty-bytes/-/pretty-bytes-5.6.0.tgz#356256f643804773c82f64723fe78c92c62beaeb"