Merge pull request #26 from Totto16/add-prettier-rc

Proposal: add prettier config

Author: JumpLink

.github/workflows/ci.yml

@@ -33,9 +33,11 @@ jobs:
     - run: yarn install
     - name: Build Types
       run: yarn run build:types
+    - name: Validate Formatting
+      run: yarn run prettier:check
     - name: Validate Types
       run: NODE_OPTIONS=--max_old_space_size=9216 yarn run validate:types
     - name: Build Example
       run: yarn run build:example
     - name: Validate Example Typescript
-      run: NODE_OPTIONS=--max_old_space_size=9216 yarn run validate:example
+      run: NODE_OPTIONS=--max_old_space_size=9216 yarn run validate:example

.prettierignore

@@ -0,0 +1,8 @@
+.vscode/
+.github/
+.yarn/
+packages/gnome-shell/dist/
+*.md
+.prettierrc
+.yarnrc.yml
+package.json

.prettierrc

@@ -0,0 +1,12 @@
+{
+    "printWidth": 256,
+    "tabWidth": 4,
+    "singleQuote": true,
+    "arrowParens": "always",
+    "semi": true,
+    "trailingComma": "es5",
+    "useTabs": false,
+    "quoteProps": "as-needed",
+    "bracketSpacing": true,
+    "endOfLine": "lf"
+}

.vscode/extensions.json

@@ -1,5 +1,6 @@
 {
   "recommendations": [
-    "arcanis.vscode-zipfs"
+    "arcanis.vscode-zipfs",
+    "esbenp.prettier-vscode"
   ]
 }

.vscode/settings.json

@@ -10,5 +10,6 @@
   // "typescript.tsserver.experimental.enableProjectDiagnostics": true,
   "cSpell.words": [
     "girs"
-  ]
+  ],
+  "prettier.prettierPath": ".yarn/sdks/prettier/index.cjs"
 }

.yarn/sdks/prettier/bin/prettier.cjs

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+const {existsSync} = require(`fs`);
+const {createRequire} = require(`module`);
+const {resolve} = require(`path`);
+
+const relPnpApiPath = "../../../../.pnp.cjs";
+
+const absPnpApiPath = resolve(__dirname, relPnpApiPath);
+const absRequire = createRequire(absPnpApiPath);
+
+if (existsSync(absPnpApiPath)) {
+  if (!process.versions.pnp) {
+    // Setup the environment to be able to require prettier/bin/prettier.cjs
+    require(absPnpApiPath).setup();
+  }
+}
+
+// Defer to the real prettier/bin/prettier.cjs your application uses
+module.exports = absRequire(`prettier/bin/prettier.cjs`);

.yarn/sdks/prettier/index.cjs

@@ -0,0 +1,20 @@
+#!/usr/bin/env node
+
+const {existsSync} = require(`fs`);
+const {createRequire} = require(`module`);
+const {resolve} = require(`path`);
+
+const relPnpApiPath = "../../../.pnp.cjs";
+
+const absPnpApiPath = resolve(__dirname, relPnpApiPath);
+const absRequire = createRequire(absPnpApiPath);
+
+if (existsSync(absPnpApiPath)) {
+  if (!process.versions.pnp) {
+    // Setup the environment to be able to require prettier
+    require(absPnpApiPath).setup();
+  }
+}
+
+// Defer to the real prettier your application uses
+module.exports = absRequire(`prettier`);

.yarn/sdks/prettier/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "prettier",
+  "version": "3.2.5-sdk",
+  "main": "./index.cjs",
+  "type": "commonjs",
+  "bin": "./bin/prettier.cjs"
+}

examples/hello-world/esbuild.js

@@ -1,9 +1,9 @@
-import { build } from "esbuild";
-import { copyFileSync } from "fs";
-import { resolve, dirname } from "path";
+import { build } from 'esbuild';
+import { copyFileSync } from 'fs';
+import { resolve, dirname } from 'path';
 import { fileURLToPath } from 'url';
-import AdmZip from "adm-zip";
-import metadata from "./src/metadata.json" assert { type: 'json' };
+import AdmZip from 'adm-zip';
+import metadata from './src/metadata.json' assert { type: 'json' };
 
 const __dirname = dirname(fileURLToPath(import.meta.url));
 
@@ -20,34 +20,33 @@ build({
     // firefox78  // Since GJS 1.65.90
     // firefox91  // Since GJS 1.71.1
     // firefox102 // Since GJS 1.73.2
-    target: "firefox78",
-    platform: "neutral",
-    platform: "node",
+    target: 'firefox78',
+    platform: 'neutral',
+    platform: 'node',
     // mainFields: ['main'],
     // conditions: ['require', 'default'],
     format: 'esm',
     external: ['gi://*', 'resource://*', 'system', 'gettext', 'cairo'],
 }).then(() => {
-    const metaSrc = resolve(__dirname, "src/metadata.json");
-    const metaDist = resolve(__dirname, "dist/metadata.json");
+    const metaSrc = resolve(__dirname, 'src/metadata.json');
+    const metaDist = resolve(__dirname, 'dist/metadata.json');
     const zipFilename = `${metadata.uuid}.zip`;
     const zipDist = resolve(__dirname, zipFilename);
     copyFileSync(metaSrc, metaDist);
 
     const zip = new AdmZip();
-    zip.addLocalFolder(resolve(__dirname, "dist"));
+    zip.addLocalFolder(resolve(__dirname, 'dist'));
     zip.writeZip(zipDist);
 
     console.log(`Build complete. Zip file: ${zipFilename}\n`);
-    console.log(`Install with: gnome-extensions install ${zipFilename}`)
-    console.log(`Update with: gnome-extensions install --force ${zipFilename}`)
-    console.log(`Enable with: gnome-extensions enable ${metadata.uuid}`)
+    console.log(`Install with: gnome-extensions install ${zipFilename}`);
+    console.log(`Update with: gnome-extensions install --force ${zipFilename}`);
+    console.log(`Enable with: gnome-extensions enable ${metadata.uuid}`);
     console.log('');
-    console.log(`Disable with: gnome-extensions disable ${metadata.uuid}`)
-    console.log(`Remove with: gnome-extensions uninstall ${metadata.uuid}`)
+    console.log(`Disable with: gnome-extensions disable ${metadata.uuid}`);
+    console.log(`Remove with: gnome-extensions uninstall ${metadata.uuid}`);
     console.log('');
-    console.log('To check if the extension has been recognized, you can execute the following: gnome-extensions list.')
+    console.log('To check if the extension has been recognized, you can execute the following: gnome-extensions list.');
     console.log(`If ${metadata.uuid} is listed in the output, you should be able to activate the extension.`);
     console.log('Otherwise, you will need to restart the GNOME Shell.');
 });
-

examples/hello-world/src/extension.ts

@@ -1,13 +1,12 @@
 import '@girs/gjs'; // For global types like `log()`
 import St from '@girs/st-14';
 
-import "@girs/gnome-shell/extensions/global"; // For global shell types
+import '@girs/gnome-shell/extensions/global'; // For global shell types
 import { Extension, gettext as _ } from '@girs/gnome-shell/extensions/extension';
 import PanelMenu from '@girs/gnome-shell/ui/panelMenu';
 import * as Main from '@girs/gnome-shell/ui/main';
 
 export default class ExampleExtension extends Extension {
-
     _indicator: PanelMenu.Button;
 
     enable() {
@@ -29,4 +28,4 @@ export default class ExampleExtension extends Extension {
         this._indicator?.destroy();
         this._indicator = null;
     }
-}
+}

examples/hello-world/src/metadata.json

@@ -1,10 +1,8 @@
 {
-  "name": "Hello World",
-  "description": "Simple Gnome Shell Hello World Extension example",
-  "uuid": "[email protected]",
-  "settings-schema": "gnome-shell.gjsify.hello-world-example",
-  "shell-version": [
-    "45"
-  ],
-  "url": "https://github.com/gjsify/gnome-shell/tree/main/examples/hello-world"
-}
+    "name": "Hello World",
+    "description": "Simple Gnome Shell Hello World Extension example",
+    "uuid": "[email protected]",
+    "settings-schema": "gnome-shell.gjsify.hello-world-example",
+    "shell-version": ["45"],
+    "url": "https://github.com/gjsify/gnome-shell/tree/main/examples/hello-world"
+}

examples/hello-world/tsconfig.json

@@ -1,13 +1,11 @@
 {
-  "compilerOptions": {   
-    "lib": ["ESNext"],
-    "types": [],
-    "target": "ESNext",
-    "module": "ESNext",
-    "moduleResolution": "Bundler"
-  },
-  "include": [],
-  "files": [
-    "src/extension.ts",
-  ]
+    "compilerOptions": {
+        "lib": ["ESNext"],
+        "types": [],
+        "target": "ESNext",
+        "module": "ESNext",
+        "moduleResolution": "Bundler"
+    },
+    "include": [],
+    "files": ["src/extension.ts"]
 }

package.json

@@ -20,7 +20,12 @@
         "publish:next": "yarn workspace @girs/gnome-shell npm publish --tolerate-republish --tag next --access public",
         "build": "yarn build:types && yarn build:example",
         "build:example": "yarn workspace @gjsify/gnome-shell-hello-world-example build",
-        "build:types": "yarn workspace @girs/gnome-shell build"
+        "build:types": "yarn workspace @girs/gnome-shell build",
+        "prettier:check": "prettier --check .",
+        "prettier:fix": "prettier --write ."
+    },
+    "gitHooks": {
+        "pre-commit": "npm run prettier:check"
     },
     "workspaces": [
         "packages/*",
@@ -49,6 +54,7 @@
     "homepage": "https://github.com/gjsify/gnome-shell#readme",
     "packageManager": "[email protected]",
     "devDependencies": {
+        "prettier": "^3.2.5",
         "typescript": "5.4.3"
     }
 }

packages/gnome-shell/scripts/config.js

@@ -2,5 +2,5 @@ import { dirname, resolve } from 'path';
 import { fileURLToPath } from 'url';
 
 export const __dirname = globalThis.__dirname || dirname(fileURLToPath(import.meta.url));
-export const SRC_DIR = resolve(__dirname,'../src');
-export const DIST_DIR = resolve(__dirname,'../dist');
+export const SRC_DIR = resolve(__dirname, '../src');
+export const DIST_DIR = resolve(__dirname, '../dist');

packages/gnome-shell/scripts/generate-exports.js

@@ -5,8 +5,8 @@ import { loadJsonFile, writeJsonFile } from './utils/json.js';
 import { DIST_DIR, __dirname } from './config.js';
 import { resolve, extname, basename } from 'path';
 
-const IGNORE_FILENAMES = ['sharedInternals.d.ts', 'global.d.ts']
-const IGNORE_DIRS = ['types']
+const IGNORE_FILENAMES = ['sharedInternals.d.ts', 'global.d.ts'];
+const IGNORE_DIRS = ['types'];
 
 /** */
 const generateExport = (filePath) => {
@@ -17,47 +17,47 @@ const generateExport = (filePath) => {
     const cjsJsPath = pathWithoutExtension + '.cjs';
     const ambientPath = pathWithoutExtension + '-ambient.d.ts';
 
-    if(IGNORE_FILENAMES.includes(fileName)) return;
-    if(fileName.endsWith('ambient.d.ts')) return;
+    if (IGNORE_FILENAMES.includes(fileName)) return;
+    if (fileName.endsWith('ambient.d.ts')) return;
 
     let exportName = pathWithoutExtension;
     exportName = basename(exportName) === 'index' ? '.' + resolve(exportName, '..') : '.' + exportName;
-    if(exportName.endsWith('/')) exportName = exportName.substring(0, exportName.length - 1);
+    if (exportName.endsWith('/')) exportName = exportName.substring(0, exportName.length - 1);
 
     const exp = {};
 
     exp[exportName] = {
         import: {
             types: `./dist${relativePath}`,
-            default: `./dist${esmJsPath}`
+            default: `./dist${esmJsPath}`,
         },
         require: {
             types: `./dist${relativePath}`,
-            default: `./dist${cjsJsPath}`
-        }
-    }
+            default: `./dist${cjsJsPath}`,
+        },
+    };
 
     exp[exportName + '/ambient'] = `./dist${ambientPath}`;
 
-    return exp
-}
+    return exp;
+};
 
 const start = async () => {
     const pkg = await loadJsonFile(resolve(__dirname, '../package.json'));
 
     const typeFiles = await getAllFiles(DIST_DIR, ['.ts'], IGNORE_DIRS);
 
     let exports = {
-        "./extensions/global": "./dist/extensions/global.d.ts"
+        './extensions/global': './dist/extensions/global.d.ts',
     };
 
     for (const absolutePath of typeFiles) {
-        exports = { ...exports, ...generateExport(absolutePath) }
+        exports = { ...exports, ...generateExport(absolutePath) };
     }
 
     pkg.exports = exports;
 
     writeJsonFile(resolve(__dirname, '../package.json'), pkg);
-}
+};
 
 await start();