@girs/gtksource-3.0 3.0.0-3.0.0-beta.13 → 3.0.0-3.0.0-beta.15

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.
Files changed (9) hide show
  1. package/README.md +60 -4
  2. package/gtksource-3.0-ambient.d.ts +9 -0
  3. package/gtksource-3.0-import.d.ts +13 -0
  4. package/gtksource-3.0.cjs +2 -0
  5. package/gtksource-3.0.d.cts +4 -1
  6. package/gtksource-3.0.d.ts +4 -1
  7. package/gtksource-3.0.js +2 -0
  8. package/package.json +16 -14
  9. package/tsconfig.doc.json +2 -0
package/README.md CHANGED
@@ -1,13 +1,13 @@
1
1
 
2
2
  # GtkSource-3.0
3
3
 
4
- GJS TypeScript type definitions for GtkSource-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gjs) v3.0.0-beta.13.
4
+ GJS TypeScript type definitions for GtkSource-3.0, generated from library version 3.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.0.0-beta.15.
5
5
 
6
6
  GtkSourceView is a portable C library that extends the standard GTK+ framework for multiline text editing with support for configurable syntax highlighting, unlimited undo/redo, search and replace, a completion framework, printing and other features typical of a source code editor.
7
7
 
8
8
  ## Install
9
9
 
10
- To use this type definitions, install them with NPM like this:
10
+ To use this type definitions, install them with NPM:
11
11
  ```bash
12
12
  npm install @girs/gtksource-3.0
13
13
  ```
@@ -24,10 +24,66 @@ Or if you prefer CommonJS, you can also use this:
24
24
  const GtkSource = require('@girs/gtksource-3.0');
25
25
  ```
26
26
 
27
- If you use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules), you can also import this module like you would do this in JavaScript:
27
+ ### Ambient Modules
28
+
29
+ You can also use [ambient modules](https://github.com/gjsify/ts-for-gir/tree/main/packages/cli#ambient-modules) to import this module like you would do this in JavaScript.
30
+ For this you need to include `@girs/gtksource-3.0` or `@girs/gtksource-3.0/ambient` in your `tsconfig` or entry point Typescript file:
31
+
32
+ `index.ts`:
33
+ ```ts
34
+ import '@girs/gtksource-3.0'
35
+ ```
36
+
37
+ `tsconfig.json`:
38
+ ```json
39
+ {
40
+ "compilerOptions": {
41
+ ...
42
+ },
43
+ "include": ["@girs/gtksource-3.0"],
44
+ ...
45
+ }
46
+ ```
47
+
48
+ Now you can import the ambient module with TypeScript support:
28
49
 
29
50
  ```ts
30
51
  import GtkSource from 'gi://GtkSource?version=3.0';
31
52
  ```
32
53
 
33
- Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
54
+
55
+ ### Global import
56
+
57
+ You can also import the module with Typescript support using the global `imports.gi` object of GJS.
58
+ For this you need to include `@girs/gtksource-3.0` or `@girs/gtksource-3.0/import` in your `tsconfig` or entry point Typescript file:
59
+
60
+ `index.ts`:
61
+ ```ts
62
+ import '@girs/gtksource-3.0'
63
+ ```
64
+
65
+ `tsconfig.json`:
66
+ ```json
67
+ {
68
+ "compilerOptions": {
69
+ ...
70
+ },
71
+ "include": ["@girs/gtksource-3.0"],
72
+ ...
73
+ }
74
+ ```
75
+
76
+ Now you have also type support for this, too:
77
+
78
+ ```ts
79
+ const GtkSource = imports.gi.GtkSource;
80
+ ```
81
+
82
+ ### Bundle
83
+
84
+ Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).
85
+
86
+ ## Other packages
87
+
88
+ All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
89
+
package/gtksource-3.0-ambient.d.ts ADDED
@@ -0,0 +1,9 @@
1
+
2
+
3
+ declare module 'gi://GtkSource?version=3.0' {
4
+ import GtkSource30 from '@girs/gtksource-3.0';
5
+ export default GtkSource30;
6
+ }
7
+
8
+
9
+
package/gtksource-3.0-import.d.ts ADDED
@@ -0,0 +1,13 @@
1
+
2
+
3
+ import GtkSource30 from '@girs/gtksource-3.0';
4
+
5
+ declare global {
6
+ export interface GjsGiImports {
7
+ GtkSource: typeof GtkSource30;
8
+ }
9
+ }
10
+
11
+ export default GjsGiImports;
12
+
13
+
package/gtksource-3.0.cjs CHANGED
@@ -7,3 +7,5 @@
7
7
 
8
8
 
9
9
 
10
+
11
+
package/gtksource-3.0.d.cts CHANGED
@@ -3,8 +3,11 @@
3
3
  * Type Definitions for Gjs (https://gjs.guide/)
4
4
  *
5
5
  * These type definitions are automatically generated, do not edit them by hand.
6
- * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gjs
6
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
7
7
  */
8
+
9
+ import './gtksource-3.0-ambient.d.ts';
10
+ import './gtksource-3.0-import.d.ts';
8
11
  /**
9
12
  * GtkSource-3.0
10
13
  */
package/gtksource-3.0.d.ts CHANGED
@@ -3,8 +3,11 @@
3
3
  * Type Definitions for Gjs (https://gjs.guide/)
4
4
  *
5
5
  * These type definitions are automatically generated, do not edit them by hand.
6
- * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gjs
6
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
7
7
  */
8
+
9
+ import './gtksource-3.0-ambient.d.ts';
10
+ import './gtksource-3.0-import.d.ts';
8
11
  /**
9
12
  * GtkSource-3.0
10
13
  */
package/gtksource-3.0.js CHANGED
@@ -6,3 +6,5 @@
6
6
  export default GtkSource;
7
7
 
8
8
 
9
+
10
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/gtksource-3.0",
3
- "version": "3.0.0-3.0.0-beta.13",
3
+ "version": "3.0.0-3.0.0-beta.15",
4
4
  "description": "GJS TypeScript type definitions for GtkSource-3.0, generated from library version 3.0.0",
5
5
  "type": "module",
6
6
  "module": "gtksource-3.0.js",
@@ -12,6 +12,8 @@
12
12
  "tsconfig": "./tsconfig.doc.json"
13
13
  },
14
14
  "exports": {
15
+ "./ambient": "./gtksource-3.0-ambient.d.ts",
16
+ "./import": "./gtksource-3.0-import.d.ts",
15
17
  ".": {
16
18
  "import": {
17
19
  "types": "./gtksource-3.0.d.ts",
@@ -29,19 +31,19 @@
29
31
  "test:cjs": "tsc --noEmit gtksource-3.0.d.cts"
30
32
  },
31
33
  "dependencies": {
32
- "@girs/atk-1.0": "^2.45.1-3.0.0-beta.13",
33
- "@girs/cairo-1.0": "^1.0.0-3.0.0-beta.13",
34
- "@girs/freetype2-2.0": "^2.0.0-3.0.0-beta.13",
35
- "@girs/gdk-3.0": "^3.24.36-3.0.0-beta.13",
36
- "@girs/gdkpixbuf-2.0": "^2.0.0-3.0.0-beta.13",
37
- "@girs/gio-2.0": "^2.76.1-3.0.0-beta.13",
38
- "@girs/glib-2.0": "^2.76.1-3.0.0-beta.13",
39
- "@girs/gmodule-2.0": "^2.0.0-3.0.0-beta.13",
40
- "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.13",
41
- "@girs/gtk-3.0": "^3.24.36-3.0.0-beta.13",
42
- "@girs/harfbuzz-0.0": "^6.0.0-3.0.0-beta.13",
43
- "@girs/pango-1.0": "^1.50.13-3.0.0-beta.13",
44
- "@girs/xlib-2.0": "^2.0.0-3.0.0-beta.13"
34
+ "@girs/gtk-3.0": "^3.24.36-3.0.0-beta.15",
35
+ "@girs/xlib-2.0": "^2.0.0-3.0.0-beta.15",
36
+ "@girs/gdk-3.0": "^3.24.36-3.0.0-beta.15",
37
+ "@girs/cairo-1.0": "^1.0.0-3.0.0-beta.15",
38
+ "@girs/pango-1.0": "^1.50.13-3.0.0-beta.15",
39
+ "@girs/harfbuzz-0.0": "^6.0.0-3.0.0-beta.15",
40
+ "@girs/freetype2-2.0": "^2.0.0-3.0.0-beta.15",
41
+ "@girs/gobject-2.0": "^2.76.1-3.0.0-beta.15",
42
+ "@girs/glib-2.0": "^2.76.1-3.0.0-beta.15",
43
+ "@girs/gio-2.0": "^2.76.1-3.0.0-beta.15",
44
+ "@girs/gdkpixbuf-2.0": "^2.0.0-3.0.0-beta.15",
45
+ "@girs/gmodule-2.0": "^2.0.0-3.0.0-beta.15",
46
+ "@girs/atk-1.0": "^2.45.1-3.0.0-beta.15"
45
47
  },
46
48
  "devDependencies": {
47
49
  "typescript": "^5.0.4"
package/tsconfig.doc.json CHANGED
@@ -17,3 +17,5 @@
17
17
  },
18
18
  "include": ["./gtksource-3.0.d.ts"]
19
19
  }
20
+
21
+