@xylabs/tsconfig-dom 7.4.18 → 7.4.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.body.md ADDED
@@ -0,0 +1,23 @@
1
+ ## Install
2
+
3
+ ```sh
4
+ yarn add -D {{name}} @xylabs/tsconfig
5
+ ```
6
+
7
+ ## Usage
8
+
9
+ Extend this config in your project's `tsconfig.json`:
10
+
11
+ ```json
12
+ {
13
+ "extends": "@xylabs/tsconfig-dom",
14
+ "compilerOptions": {
15
+ "outDir": "./dist"
16
+ },
17
+ "include": ["src"]
18
+ }
19
+ ```
20
+
21
+ This extends [`@xylabs/tsconfig`](https://www.npmjs.com/package/@xylabs/tsconfig) and adds `DOM` and `DOM.Iterable` to the `lib` array, making browser APIs like `window`, `document`, and DOM iterables available.
22
+
23
+ For React projects, use [`@xylabs/tsconfig-react`](https://www.npmjs.com/package/@xylabs/tsconfig-react) which extends this config with JSX support.
package/README.md ADDED
@@ -0,0 +1,45 @@
1
+ [![logo][]](https://xylabs.com)
2
+
3
+ # @xylabs/tsconfig-dom
4
+
5
+ [![npm][npm-badge]][npm-link]
6
+ [![license][license-badge]][license-link]
7
+
8
+ > Typescript Base Config used throughout XY Labs TypeScript/JavaScript libraries and react projects
9
+
10
+ ## Install
11
+
12
+ ```sh
13
+ yarn add -D {{name}} @xylabs/tsconfig
14
+ ```
15
+
16
+ ## Usage
17
+
18
+ Extend this config in your project's `tsconfig.json`:
19
+
20
+ ```json
21
+ {
22
+ "extends": "@xylabs/tsconfig-dom",
23
+ "compilerOptions": {
24
+ "outDir": "./dist"
25
+ },
26
+ "include": ["src"]
27
+ }
28
+ ```
29
+
30
+ This extends [`@xylabs/tsconfig`](https://www.npmjs.com/package/@xylabs/tsconfig) and adds `DOM` and `DOM.Iterable` to the `lib` array, making browser APIs like `window`, `document`, and DOM iterables available.
31
+
32
+ For React projects, use [`@xylabs/tsconfig-react`](https://www.npmjs.com/package/@xylabs/tsconfig-react) which extends this config with JSX support.
33
+
34
+
35
+ ## License
36
+
37
+ See the [LICENSE](LICENSE) file for license rights and limitations (LGPL-3.0-only).
38
+
39
+
40
+
41
+ [logo]: https://cdn.xy.company/img/brand/XYPersistentCompany_Logo_Icon_Colored.svg
42
+ [npm-badge]: https://img.shields.io/npm/v/@xylabs/tsconfig-dom.svg
43
+ [npm-link]: https://www.npmjs.com/package/@xylabs/tsconfig-dom
44
+ [license-badge]: https://img.shields.io/npm/l/@xylabs/tsconfig-dom.svg
45
+ [license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "http://json.schemastore.org/package.json",
3
3
  "name": "@xylabs/tsconfig-dom",
4
- "version": "7.4.18",
4
+ "version": "7.4.19",
5
5
  "description": "Typescript Base Config used throughout XY Labs TypeScript/JavaScript libraries and react projects",
6
6
  "keywords": [
7
7
  "xylabs",
@@ -38,11 +38,11 @@
38
38
  "package-compile": "echo Compiled"
39
39
  },
40
40
  "devDependencies": {
41
- "@xylabs/ts-scripts-yarn3": "~7.4.18",
42
- "@xylabs/tsconfig": "~7.4.18"
41
+ "@xylabs/ts-scripts-yarn3": "~7.4.19",
42
+ "@xylabs/tsconfig": "~7.4.19"
43
43
  },
44
44
  "peerDependencies": {
45
- "@xylabs/tsconfig": "~7.4.18"
45
+ "@xylabs/tsconfig": "~7.4.19"
46
46
  },
47
47
  "publishConfig": {
48
48
  "access": "public"