mirror of
https://github.com/yu-i-i/overleaf-cep.git
synced 2026-11-14 22:23:42 +01:00
Centralize prettier configuration to root level (#30501)
* Merge all .prettierignore files into top-level config * Merge all .prettierrc files into top-level config * Replace service-specific glob patterns in package.json format scripts with `prettier .` * Add template files with Jinja2, Go template, envsubst, and Handlebars syntax to .prettierignore * Ignore GitHub templates * Ignore PUG templates to format them separately with `format:pug` * Encourage double quotes for YAML, YML files * Move prettier for PUG source format script to the root * Move prettier for styles source format script to the root * Remove prettier for jenkins files from web * Remove prettier source format script from all services * Make .prettierrc more readable * Update format scripts by file type * Organise `.prettierignore` * Add `--cache` flag to prettier scripts for faster runs * Format all files with prettier * Format all or format services * Remove `format`/`format:fix` scripts from services since now it runs from root `package.json` * Avoid conlficts with yamllint configuration * Remove `--cache` flag from prettier scripts * Update all service Makefiles to use root-level prettier configuration * Update all Jenkinsfile to use root-level prettier configuration * Ignore auto-generated files by build_scripts * Update package-lock.json * Update root Makefile format targets * Update SP Jenkinsfile format target * Update E2E Makefile format script * Udpate `format_js` to work in both local and CI env * Add docker-mailtrap to .prettierignore docker-mailtrap is a third-party git-ignored directory used for testing * Added Docker env detection to prevent nested Docker spawning * Ignore handlebars templates * Add cryptographic files and test output to `.prettierignore` * Add terraform modules to `.gitignore` * Remove prettier-plugin-groovy * Use npx directly instead of Docker for local formatting for faster formatting * Auto-generate Makefiles * Revert "Remove prettier-plugin-groovy" This reverts commit 194a33589a2e1e4d2225d10c67e9f025e4222025. * Mount monorepo root in RUN_LINT_FORMAT for prettier config access * Prettier ignores all `node_modules` by default regardless of location * Show only changed files in format output * Ignore LICENSE files * Enable prettier on rendered build_scripts outputs * Ignoring all the template folders by prettier * Remove the public/minjs entry since it does not exist * Remove all non-existent paths * Sync `.prettierignore` with ignored files by `.gitignore` and `.dockerignore` files * Revert "Auto-generate Makefiles" This reverts commit c0233e490de1bc95fe437219d65e0b66e0331ec9. * Revert "Use npx directly instead of Docker for local formatting for faster formatting" This reverts commit 1d2b2cf1a6c6974c76885852a90dd55e84167e41. * Ignore dashboard JSON files * Ignore files generated by bin/update_build_scripts * Remove unsupported file types from `.prettierignore` * Ignore test fixture generated files * Ignore README file types by prettier * Ignore generate snapshots by prettier * Allow to format generated bin/update_build_scripts by prettier * Ensure build script outputs prettier-compatible tsconfig.json * Fix build script output to match prettier formatting - Fix Jinja2 whitespace in docker-compose templates - Change YAML quotes from single to double * Don't read cryptographic files by prettier * Ignore google verification files by prettier * Revert npx prettier formatting * Ignore domain verification files * Show only changed files in format output * Make `.github` prettier * Allow all files to be formatted in jobs by prettier * Allow server-ce/server-pro files to be formatted by prettier * Ignore more folders in clsi, filestory, git-bridge by prettier * Update build script with `RUN_LINTING_CI_MONOREPO` * Ignore docker-mailtrap and downloads in server-ce by prettier * Restore prettier configs and prettierignore for V1 since it has its own prettier (an older version) * Source format GitOrigin-RevId: 637adc3cc422d1f20c86d6ebc8ec514d60758287
This commit is contained in:
+67
-53
@@ -16,23 +16,23 @@ Light-weight helpers for handling JavaScript Errors in node.js and the browser.
|
||||
<!-- toc -->
|
||||
|
||||
- [Long Stack Traces with `OError.tag`](#long-stack-traces-with-oerrortag)
|
||||
* [The Problem](#the-problem)
|
||||
* [The Solution](#the-solution)
|
||||
* [Adding More Info](#adding-more-info)
|
||||
* [`async`/`await`](#asyncawait)
|
||||
* [Better Async Stack Traces in Node 12+](#better-async-stack-traces-in-node-12)
|
||||
* [Caveat: Shared Error Instances](#caveat-shared-error-instances)
|
||||
- [The Problem](#the-problem)
|
||||
- [The Solution](#the-solution)
|
||||
- [Adding More Info](#adding-more-info)
|
||||
- [`async`/`await`](#asyncawait)
|
||||
- [Better Async Stack Traces in Node 12+](#better-async-stack-traces-in-node-12)
|
||||
- [Caveat: Shared Error Instances](#caveat-shared-error-instances)
|
||||
- [Create Custom Error Classes](#create-custom-error-classes)
|
||||
* [Attaching Extra Info](#attaching-extra-info)
|
||||
* [Wrapping an Internal Error](#wrapping-an-internal-error)
|
||||
- [Attaching Extra Info](#attaching-extra-info)
|
||||
- [Wrapping an Internal Error](#wrapping-an-internal-error)
|
||||
- [OError API Reference](#oerror-api-reference)
|
||||
* [new OError(message, [info], [cause])](#new-oerrormessage-info-cause)
|
||||
* [oError.withInfo(info) ⇒ this](#oerrorwithinfoinfo--this)
|
||||
* [oError.withCause(cause) ⇒ this](#oerrorwithcausecause--this)
|
||||
* [OError.maxTags : Number](#oerrormaxtags--number)
|
||||
* [OError.tag(error, [message], [info]) ⇒ Error](#oerrortagerror-message-info--error)
|
||||
* [OError.getFullInfo(error) ⇒ Object](#oerrorgetfullinfoerror--object)
|
||||
* [OError.getFullStack(error) ⇒ string](#oerrorgetfullstackerror--string)
|
||||
- [new OError(message, [info], [cause])](#new-oerrormessage-info-cause)
|
||||
- [oError.withInfo(info) ⇒ this](#oerrorwithinfoinfo--this)
|
||||
- [oError.withCause(cause) ⇒ this](#oerrorwithcausecause--this)
|
||||
- [OError.maxTags : Number](#oerrormaxtags--number)
|
||||
- [OError.tag(error, [message], [info]) ⇒ Error](#oerrortagerror-message-info--error)
|
||||
- [OError.getFullInfo(error) ⇒ Object](#oerrorgetfullinfoerror--object)
|
||||
- [OError.getFullStack(error) ⇒ string](#oerrorgetfullstackerror--string)
|
||||
- [References](#references)
|
||||
|
||||
<!-- tocstop -->
|
||||
@@ -345,52 +345,56 @@ caused by:
|
||||
## OError API Reference
|
||||
|
||||
<a name="OError"></a>
|
||||
* [OError](#OError)
|
||||
* [new OError(message, [info], [cause])](#new_OError_new)
|
||||
* _instance_
|
||||
* [.withInfo(info)](#OError+withInfo) ⇒ <code>this</code>
|
||||
* [.withCause(cause)](#OError+withCause) ⇒ <code>this</code>
|
||||
* _static_
|
||||
* [.maxTags](#OError.maxTags) : <code>Number</code>
|
||||
* [.tag(error, [message], [info])](#OError.tag) ⇒ <code>Error</code>
|
||||
* [.getFullInfo(error)](#OError.getFullInfo) ⇒ <code>Object</code>
|
||||
* [.getFullStack(error)](#OError.getFullStack) ⇒ <code>string</code>
|
||||
|
||||
- [OError](#OError)
|
||||
- [new OError(message, [info], [cause])](#new_OError_new)
|
||||
- _instance_
|
||||
- [.withInfo(info)](#OError+withInfo) ⇒ <code>this</code>
|
||||
- [.withCause(cause)](#OError+withCause) ⇒ <code>this</code>
|
||||
- _static_
|
||||
- [.maxTags](#OError.maxTags) : <code>Number</code>
|
||||
- [.tag(error, [message], [info])](#OError.tag) ⇒ <code>Error</code>
|
||||
- [.getFullInfo(error)](#OError.getFullInfo) ⇒ <code>Object</code>
|
||||
- [.getFullStack(error)](#OError.getFullStack) ⇒ <code>string</code>
|
||||
|
||||
<a name="new_OError_new"></a>
|
||||
|
||||
### new OError(message, [info], [cause])
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| message | <code>string</code> | as for built-in Error |
|
||||
| [info] | <code>Object</code> | extra data to attach to the error |
|
||||
| [cause] | <code>Error</code> | the internal error that caused this error |
|
||||
| Param | Type | Description |
|
||||
| ------- | ------------------- | ----------------------------------------- |
|
||||
| message | <code>string</code> | as for built-in Error |
|
||||
| [info] | <code>Object</code> | extra data to attach to the error |
|
||||
| [cause] | <code>Error</code> | the internal error that caused this error |
|
||||
|
||||
<a name="OError+withInfo"></a>
|
||||
|
||||
### oError.withInfo(info) ⇒ <code>this</code>
|
||||
|
||||
Set the extra info object for this error.
|
||||
|
||||
**Kind**: instance method of [<code>OError</code>](#OError)
|
||||
**Kind**: instance method of [<code>OError</code>](#OError)
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| info | <code>Object</code> | extra data to attach to the error |
|
||||
| Param | Type | Description |
|
||||
| ----- | ------------------- | --------------------------------- |
|
||||
| info | <code>Object</code> | extra data to attach to the error |
|
||||
|
||||
<a name="OError+withCause"></a>
|
||||
|
||||
### oError.withCause(cause) ⇒ <code>this</code>
|
||||
|
||||
Wrap the given error, which caused this error.
|
||||
|
||||
**Kind**: instance method of [<code>OError</code>](#OError)
|
||||
**Kind**: instance method of [<code>OError</code>](#OError)
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| Param | Type | Description |
|
||||
| ----- | ------------------ | ----------------------------------------- |
|
||||
| cause | <code>Error</code> | the internal error that caused this error |
|
||||
|
||||
<a name="OError.maxTags"></a>
|
||||
|
||||
### OError.maxTags : <code>Number</code>
|
||||
|
||||
Maximum number of tags to apply to any one error instance. This is to avoid
|
||||
a resource leak in the (hopefully unlikely) case that a singleton error
|
||||
instance is returned to many callbacks. If tags have been dropped, the full
|
||||
@@ -402,19 +406,21 @@ Defaults to 100. Must be at least 1.
|
||||
<a name="OError.tag"></a>
|
||||
|
||||
### OError.tag(error, [message], [info]) ⇒ <code>Error</code>
|
||||
|
||||
Tag debugging information onto any error (whether an OError or not) and
|
||||
return it.
|
||||
|
||||
**Kind**: static method of [<code>OError</code>](#OError)
|
||||
**Returns**: <code>Error</code> - the modified `error` argument
|
||||
**Returns**: <code>Error</code> - the modified `error` argument
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| error | <code>Error</code> | the error to tag |
|
||||
| [message] | <code>string</code> | message with which to tag `error` |
|
||||
| [info] | <code>Object</code> | extra data with wich to tag `error` |
|
||||
| Param | Type | Description |
|
||||
| --------- | ------------------- | ----------------------------------- |
|
||||
| error | <code>Error</code> | the error to tag |
|
||||
| [message] | <code>string</code> | message with which to tag `error` |
|
||||
| [info] | <code>Object</code> | extra data with wich to tag `error` |
|
||||
|
||||
**Example** _(An error in a callback)_
|
||||
|
||||
**Example** *(An error in a callback)*
|
||||
```js
|
||||
function findUser(name, callback) {
|
||||
fs.readFile('/etc/passwd', (err, data) => {
|
||||
@@ -423,13 +429,17 @@ function findUser(name, callback) {
|
||||
})
|
||||
}
|
||||
```
|
||||
**Example** *(A possible error in a callback)*
|
||||
|
||||
**Example** _(A possible error in a callback)_
|
||||
|
||||
```js
|
||||
function cleanup(callback) {
|
||||
fs.unlink('/tmp/scratch', (err) => callback(err && OError.tag(err)))
|
||||
fs.unlink('/tmp/scratch', err => callback(err && OError.tag(err)))
|
||||
}
|
||||
```
|
||||
**Example** *(An error with async/await)*
|
||||
|
||||
**Example** _(An error with async/await)_
|
||||
|
||||
```js
|
||||
async function cleanup() {
|
||||
try {
|
||||
@@ -439,30 +449,34 @@ async function cleanup() {
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<a name="OError.getFullInfo"></a>
|
||||
|
||||
### OError.getFullInfo(error) ⇒ <code>Object</code>
|
||||
|
||||
The merged info from any `tag`s and causes on the given error.
|
||||
|
||||
If an info property is repeated, the last one wins.
|
||||
|
||||
**Kind**: static method of [<code>OError</code>](#OError)
|
||||
**Kind**: static method of [<code>OError</code>](#OError)
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| Param | Type | Description |
|
||||
| ----- | ----------------------------------------------------------------- | ----------------------------------------- |
|
||||
| error | <code>Error</code> \| <code>null</code> \| <code>undefined</code> | any error (may or may not be an `OError`) |
|
||||
|
||||
<a name="OError.getFullStack"></a>
|
||||
|
||||
### OError.getFullStack(error) ⇒ <code>string</code>
|
||||
|
||||
Return the `stack` property from `error`, including the `stack`s for any
|
||||
tagged errors added with `OError.tag` and for any `cause`s.
|
||||
|
||||
**Kind**: static method of [<code>OError</code>](#OError)
|
||||
**Kind**: static method of [<code>OError</code>](#OError)
|
||||
|
||||
| Param | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| Param | Type | Description |
|
||||
| ----- | ----------------------------------------------------------------- | ----------------------------------------- |
|
||||
| error | <code>Error</code> \| <code>null</code> \| <code>undefined</code> | any error (may or may not be an `OError`) |
|
||||
|
||||
<!-- END API REFERENCE -->
|
||||
|
||||
## References
|
||||
|
||||
@@ -20,9 +20,7 @@
|
||||
"build": "npm run --silent test",
|
||||
"lint": "eslint --ext .cjs,.js,.jsx,.mjs,.ts --max-warnings 0 --format unix .",
|
||||
"lint:fix": "eslint --fix --ext .cjs,.js,.jsx,.mjs,.ts .",
|
||||
"test": "npm run lint && npm run format && npm run types:check && npm run test:unit",
|
||||
"format": "prettier --list-different $PWD/'**/*.{js,cjs,ts}'",
|
||||
"format:fix": "prettier --write $PWD/'**/*.{js,cjs,ts}'",
|
||||
"test": "npm run lint && npm run types:check && npm run test:unit",
|
||||
"test:ci": "npm run test:unit",
|
||||
"test:unit": "mocha --exit test/**/*.{js,cjs}",
|
||||
"types:check": "tsc --noEmit"
|
||||
|
||||
@@ -1,8 +1,4 @@
|
||||
{
|
||||
"extends": "../../tsconfig.backend.json",
|
||||
"include": [
|
||||
"**/*.js",
|
||||
"**/*.cjs",
|
||||
"**/*.ts"
|
||||
]
|
||||
"include": ["**/*.js", "**/*.cjs", "**/*.ts"]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user