@girs/clutter-14 14.0.0-4.0.0-beta.2 → 14.0.0-4.0.0-beta.3

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 (3) hide show
  1. package/README.md +1 -19
  2. package/clutter-14.d.ts +7 -8
  3. package/package.json +17 -18
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  ![downloads/week](https://img.shields.io/npm/dw/@girs/clutter-14)
6
6
 
7
7
 
8
- GJS TypeScript type definitions for Clutter-14, generated from library version 14.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.2.
8
+ GJS TypeScript type definitions for Clutter-14, generated from library version 14.0.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.0.0-beta.3.
9
9
 
10
10
 
11
11
  ## Install
@@ -22,11 +22,6 @@ You can import this package into your project like this:
22
22
  import Clutter from '@girs/clutter-14';
23
23
  ```
24
24
 
25
- Or if you prefer CommonJS, you can also use this:
26
- ```ts
27
- const Clutter = require('@girs/clutter-14');
28
- ```
29
-
30
25
  ### Ambient Modules
31
26
 
32
27
  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.
@@ -81,19 +76,6 @@ Now you have also type support for this, too:
81
76
  const Clutter = imports.gi.Clutter;
82
77
  ```
83
78
 
84
-
85
- ### ESM vs. CommonJS
86
-
87
- GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
88
-
89
- In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
90
-
91
- On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
92
-
93
- This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
94
-
95
- Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
96
-
97
79
  ### Bundle
98
80
 
99
81
  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).
package/clutter-14.d.ts CHANGED
@@ -17,7 +17,6 @@ import type GLib from '@girs/glib-2.0';
17
17
  import type Mtk from '@girs/mtk-14';
18
18
  import type Graphene from '@girs/graphene-1.0';
19
19
  import type Gio from '@girs/gio-2.0';
20
- import type GModule from '@girs/gmodule-2.0';
21
20
  import type GL from '@girs/gl-1.0';
22
21
  import type CoglPango from '@girs/coglpango-14';
23
22
  import type PangoCairo from '@girs/pangocairo-1.0';
@@ -8821,7 +8820,7 @@ export namespace Clutter {
8821
8820
  * static void
8822
8821
  * my_object_class_init (MyObjectClass *klass)
8823
8822
  * {
8824
- * properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
8823
+ * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
8825
8824
  * 0, 100,
8826
8825
  * 50,
8827
8826
  * G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -10566,7 +10565,7 @@ export namespace Clutter {
10566
10565
  * static void
10567
10566
  * my_object_class_init (MyObjectClass *klass)
10568
10567
  * {
10569
- * properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
10568
+ * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
10570
10569
  * 0, 100,
10571
10570
  * 50,
10572
10571
  * G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -12863,7 +12862,7 @@ export namespace Clutter {
12863
12862
  * static void
12864
12863
  * my_object_class_init (MyObjectClass *klass)
12865
12864
  * {
12866
- * properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
12865
+ * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
12867
12866
  * 0, 100,
12868
12867
  * 50,
12869
12868
  * G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -15032,7 +15031,7 @@ export namespace Clutter {
15032
15031
  * static void
15033
15032
  * my_object_class_init (MyObjectClass *klass)
15034
15033
  * {
15035
- * properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
15034
+ * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
15036
15035
  * 0, 100,
15037
15036
  * 50,
15038
15037
  * G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -16613,7 +16612,7 @@ export namespace Clutter {
16613
16612
  * static void
16614
16613
  * my_object_class_init (MyObjectClass *klass)
16615
16614
  * {
16616
- * properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
16615
+ * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
16617
16616
  * 0, 100,
16618
16617
  * 50,
16619
16618
  * G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -18341,7 +18340,7 @@ export namespace Clutter {
18341
18340
  * static void
18342
18341
  * my_object_class_init (MyObjectClass *klass)
18343
18342
  * {
18344
- * properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
18343
+ * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
18345
18344
  * 0, 100,
18346
18345
  * 50,
18347
18346
  * G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
@@ -19058,7 +19057,7 @@ export namespace Clutter {
19058
19057
  * static void
19059
19058
  * my_object_class_init (MyObjectClass *klass)
19060
19059
  * {
19061
- * properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
19060
+ * properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
19062
19061
  * 0, 100,
19063
19062
  * 50,
19064
19063
  * G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@girs/clutter-14",
3
- "version": "14.0.0-4.0.0-beta.2",
3
+ "version": "14.0.0-4.0.0-beta.3",
4
4
  "description": "GJS TypeScript type definitions for Clutter-14, generated from library version 14.0.0",
5
5
  "type": "module",
6
6
  "module": "clutter-14.js",
@@ -26,23 +26,22 @@
26
26
  "test": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit clutter-14.d.ts"
27
27
  },
28
28
  "dependencies": {
29
- "@girs/atk-1.0": "^2.52.0-4.0.0-beta.2",
30
- "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.2",
31
- "@girs/cogl-14": "^14.0.0-4.0.0-beta.2",
32
- "@girs/coglpango-14": "^14.0.0-4.0.0-beta.2",
33
- "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.2",
34
- "@girs/gio-2.0": "^2.80.0-4.0.0-beta.2",
35
- "@girs/gjs": "^4.0.0-beta.2",
36
- "@girs/gl-1.0": "^1.0.0-4.0.0-beta.2",
37
- "@girs/glib-2.0": "^2.80.0-4.0.0-beta.2",
38
- "@girs/gmodule-2.0": "^2.0.0-4.0.0-beta.2",
39
- "@girs/gobject-2.0": "^2.80.0-4.0.0-beta.2",
40
- "@girs/graphene-1.0": "^1.0.0-4.0.0-beta.2",
41
- "@girs/harfbuzz-0.0": "^8.3.1-4.0.0-beta.2",
42
- "@girs/mtk-14": "^14.0.0-4.0.0-beta.2",
43
- "@girs/pango-1.0": "^1.51.2-4.0.0-beta.2",
44
- "@girs/pangocairo-1.0": "^1.0.0-4.0.0-beta.2",
45
- "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.2"
29
+ "@girs/atk-1.0": "^2.52.0-4.0.0-beta.3",
30
+ "@girs/cairo-1.0": "^1.0.0-4.0.0-beta.3",
31
+ "@girs/cogl-14": "^14.0.0-4.0.0-beta.3",
32
+ "@girs/coglpango-14": "^14.0.0-4.0.0-beta.3",
33
+ "@girs/freetype2-2.0": "^2.0.0-4.0.0-beta.3",
34
+ "@girs/gio-2.0": "^2.80.0-4.0.0-beta.3",
35
+ "@girs/gjs": "^4.0.0-beta.3",
36
+ "@girs/gl-1.0": "^1.0.0-4.0.0-beta.3",
37
+ "@girs/glib-2.0": "^2.80.0-4.0.0-beta.3",
38
+ "@girs/gobject-2.0": "^2.80.0-4.0.0-beta.3",
39
+ "@girs/graphene-1.0": "^1.0.0-4.0.0-beta.3",
40
+ "@girs/harfbuzz-0.0": "^8.3.1-4.0.0-beta.3",
41
+ "@girs/mtk-14": "^14.0.0-4.0.0-beta.3",
42
+ "@girs/pango-1.0": "^1.51.0-4.0.0-beta.3",
43
+ "@girs/pangocairo-1.0": "^1.0.0-4.0.0-beta.3",
44
+ "@girs/xlib-2.0": "^2.0.0-4.0.0-beta.3"
46
45
  },
47
46
  "devDependencies": {
48
47
  "typescript": "*"