refactor start
This commit is contained in:
Spectre
parent
bd49791e06
commit
e46d25f0b7
16699 changed files with 2 additions and 1484887 deletions
105
home/ags/node_modules/@girs/gio-2.0/README.md
generated
vendored
105
home/ags/node_modules/@girs/gio-2.0/README.md
generated
vendored
|
|
@ -1,105 +0,0 @@
|
|||
|
||||
# Gio-2.0
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
GJS TypeScript type definitions for Gio-2.0, generated from library version 2.78.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.3.0.
|
||||
|
||||
GIO provides a modern and easy-to-use VFS API. It provides a file system abstraction which allows applications to access local and remote files with a single consistent API.
|
||||
|
||||
## Install
|
||||
|
||||
To use this type definitions, install them with NPM:
|
||||
```bash
|
||||
npm install @girs/gio-2.0
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
You can import this package into your project like this:
|
||||
```ts
|
||||
import Gio from '@girs/gio-2.0';
|
||||
```
|
||||
|
||||
Or if you prefer CommonJS, you can also use this:
|
||||
```ts
|
||||
const Gio = require('@girs/gio-2.0');
|
||||
```
|
||||
|
||||
### Ambient Modules
|
||||
|
||||
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.
|
||||
For this you need to include `@girs/gio-2.0` or `@girs/gio-2.0/ambient` in your `tsconfig` or entry point Typescript file:
|
||||
|
||||
`index.ts`:
|
||||
```ts
|
||||
import '@girs/gio-2.0'
|
||||
```
|
||||
|
||||
`tsconfig.json`:
|
||||
```json
|
||||
{
|
||||
"compilerOptions": {
|
||||
...
|
||||
},
|
||||
"include": ["@girs/gio-2.0"],
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
Now you can import the ambient module with TypeScript support:
|
||||
|
||||
```ts
|
||||
import Gio from 'gi://Gio?version=2.0';
|
||||
```
|
||||
|
||||
### Global import
|
||||
|
||||
You can also import the module with Typescript support using the global `imports.gi` object of GJS.
|
||||
For this you need to include `@girs/gio-2.0` or `@girs/gio-2.0/import` in your `tsconfig` or entry point Typescript file:
|
||||
|
||||
`index.ts`:
|
||||
```ts
|
||||
import '@girs/gio-2.0'
|
||||
```
|
||||
|
||||
`tsconfig.json`:
|
||||
```json
|
||||
{
|
||||
"compilerOptions": {
|
||||
...
|
||||
},
|
||||
"include": ["@girs/gio-2.0"],
|
||||
...
|
||||
}
|
||||
```
|
||||
|
||||
Now you have also type support for this, too:
|
||||
|
||||
```ts
|
||||
const Gio = imports.gi.Gio;
|
||||
```
|
||||
|
||||
|
||||
### ESM vs. CommonJS
|
||||
|
||||
GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
### Bundle
|
||||
|
||||
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).
|
||||
|
||||
## Other packages
|
||||
|
||||
All existing pre-generated packages can be found on [gjsify/types](https://github.com/gjsify/types).
|
||||
|
||||
12
home/ags/node_modules/@girs/gio-2.0/gio-2.0-ambient.d.ts
generated
vendored
12
home/ags/node_modules/@girs/gio-2.0/gio-2.0-ambient.d.ts
generated
vendored
|
|
@ -1,12 +0,0 @@
|
|||
|
||||
declare module 'gi://Gio?version=2.0' {
|
||||
import Gio20 from '@girs/gio-2.0';
|
||||
export default Gio20;
|
||||
}
|
||||
|
||||
declare module 'gi://Gio' {
|
||||
import Gio20 from '@girs/gio-2.0';
|
||||
export default Gio20;
|
||||
}
|
||||
|
||||
|
||||
2
home/ags/node_modules/@girs/gio-2.0/gio-2.0-ambient.js
generated
vendored
2
home/ags/node_modules/@girs/gio-2.0/gio-2.0-ambient.js
generated
vendored
|
|
@ -1,2 +0,0 @@
|
|||
export {}
|
||||
|
||||
12
home/ags/node_modules/@girs/gio-2.0/gio-2.0-import.d.ts
generated
vendored
12
home/ags/node_modules/@girs/gio-2.0/gio-2.0-import.d.ts
generated
vendored
|
|
@ -1,12 +0,0 @@
|
|||
|
||||
import Gio20 from '@girs/gio-2.0';
|
||||
|
||||
declare global {
|
||||
export interface GjsGiImports {
|
||||
Gio: typeof Gio20;
|
||||
}
|
||||
}
|
||||
|
||||
export default GjsGiImports;
|
||||
|
||||
|
||||
3
home/ags/node_modules/@girs/gio-2.0/gio-2.0-import.js
generated
vendored
3
home/ags/node_modules/@girs/gio-2.0/gio-2.0-import.js
generated
vendored
|
|
@ -1,3 +0,0 @@
|
|||
const gi = globalThis.imports?.gi || {};
|
||||
export default gi;
|
||||
|
||||
11
home/ags/node_modules/@girs/gio-2.0/gio-2.0.cjs
generated
vendored
11
home/ags/node_modules/@girs/gio-2.0/gio-2.0.cjs
generated
vendored
|
|
@ -1,11 +0,0 @@
|
|||
|
||||
|
||||
imports.gi.versions.Gio = '2.0'
|
||||
const Gio = imports.gi.Gio;
|
||||
|
||||
module.exports = Gio;
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
53528
home/ags/node_modules/@girs/gio-2.0/gio-2.0.d.cts
generated
vendored
53528
home/ags/node_modules/@girs/gio-2.0/gio-2.0.d.cts
generated
vendored
File diff suppressed because it is too large
Load diff
53533
home/ags/node_modules/@girs/gio-2.0/gio-2.0.d.ts
generated
vendored
53533
home/ags/node_modules/@girs/gio-2.0/gio-2.0.d.ts
generated
vendored
File diff suppressed because it is too large
Load diff
10
home/ags/node_modules/@girs/gio-2.0/gio-2.0.js
generated
vendored
10
home/ags/node_modules/@girs/gio-2.0/gio-2.0.js
generated
vendored
|
|
@ -1,10 +0,0 @@
|
|||
|
||||
|
||||
// @ts-expect-error
|
||||
import Gio from 'gi://Gio?version=2.0';
|
||||
export { Gio };
|
||||
export default Gio;
|
||||
|
||||
|
||||
|
||||
|
||||
59
home/ags/node_modules/@girs/gio-2.0/package.json
generated
vendored
59
home/ags/node_modules/@girs/gio-2.0/package.json
generated
vendored
|
|
@ -1,59 +0,0 @@
|
|||
{
|
||||
"name": "@girs/gio-2.0",
|
||||
"version": "2.78.0-3.3.0",
|
||||
"description": "GJS TypeScript type definitions for Gio-2.0, generated from library version 2.78.0",
|
||||
"type": "module",
|
||||
"module": "gio-2.0.js",
|
||||
"main": "gio-2.0.js",
|
||||
"exports": {
|
||||
"./ambient": {
|
||||
"types": "./gio-2.0-ambient.d.ts",
|
||||
"default": "./gio-2.0-ambient.js"
|
||||
},
|
||||
"./import": {
|
||||
"types": "./gio-2.0-import.d.ts",
|
||||
"default": "./gio-2.0-import.js"
|
||||
},
|
||||
".": {
|
||||
"import": {
|
||||
"types": "./gio-2.0.d.ts",
|
||||
"default": "./gio-2.0.js"
|
||||
},
|
||||
"require": {
|
||||
"types": "./gio-2.0.d.cts",
|
||||
"default": "./gio-2.0.cjs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"scripts": {
|
||||
"test": "yarn test:esm && yarn test:cjs",
|
||||
"test:esm": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gio-2.0.d.ts",
|
||||
"test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit gio-2.0.d.cts"
|
||||
},
|
||||
"dependencies": {
|
||||
"@girs/gjs": "^3.3.0",
|
||||
"@girs/glib-2.0": "^2.78.0-3.3.0",
|
||||
"@girs/gobject-2.0": "^2.78.0-3.3.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"typescript": "*"
|
||||
},
|
||||
"keywords": [
|
||||
"Gir",
|
||||
"TypeScript",
|
||||
"types",
|
||||
"GObject-Introspection",
|
||||
"GJS",
|
||||
"Gio-2.0"
|
||||
],
|
||||
"author": "ts-for-gir",
|
||||
"license": "MIT",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/gjsify/ts-for-gir.git"
|
||||
},
|
||||
"bugs": {
|
||||
"url": "https://github.com/gjsify/ts-for-gir/issues"
|
||||
},
|
||||
"homepage": "https://github.com/gjsify/types/tree/main/gio-2.0#readme"
|
||||
}
|
||||
23
home/ags/node_modules/@girs/gio-2.0/tsconfig.json
generated
vendored
23
home/ags/node_modules/@girs/gio-2.0/tsconfig.json
generated
vendored
|
|
@ -1,23 +0,0 @@
|
|||
{
|
||||
"compilerOptions": {
|
||||
// General settings for code interpretation
|
||||
"target": "ESNext",
|
||||
"module": "ESNext",
|
||||
"lib": ["ESNext"],
|
||||
"types": [],
|
||||
"experimentalDecorators": true,
|
||||
"moduleResolution": "node",
|
||||
"noEmit": true,
|
||||
"noEmitOnError": false,
|
||||
"baseUrl": "./",
|
||||
"rootDir": ".",
|
||||
// General settings for code generation
|
||||
"removeComments": false,
|
||||
"inlineSourceMap": false,
|
||||
"inlineSources": false,
|
||||
"newLine": "LF"
|
||||
},
|
||||
"include": ["./gio-2.0.d.ts"]
|
||||
}
|
||||
|
||||
|
||||
7
home/ags/node_modules/@girs/gio-2.0/typedoc.json
generated
vendored
7
home/ags/node_modules/@girs/gio-2.0/typedoc.json
generated
vendored
|
|
@ -1,7 +0,0 @@
|
|||
{
|
||||
"entryPoints": ["./gio-2.0.d.ts"],
|
||||
"readme": "./README.md",
|
||||
"name": "Gio-2.0",
|
||||
"tsconfig": "./tsconfig.json"
|
||||
}
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue