chore: setup prettier (#195)

manzt · web-flow · commit fa84359a44eb · 2023-07-20T13:26:28.000-04:00
diff --git a/.changeset/five-turtles-sell.md b/.changeset/five-turtles-sell.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -1,6 +1,5 @@
 version: 2
 updates:
-
   # Maintain dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -9,7 +9,6 @@ on:
       - main
 
 jobs:
-
   LintPython:
     name: Python / Lint
     runs-on: ubuntu-latest
@@ -46,6 +45,19 @@ jobs:
 
       - uses: codecov/codecov-action@v3
 
+  LintJavaScript:
+    name: JavaScript / Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: pnpm/action-setup@v2
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "18.x"
+      - run: |
+          pnpm install
+          pnpm lint
+
   TypecheckJavaScript:
     name: JavaScript / Typecheck
     runs-on: ubuntu-latest
@@ -54,7 +66,7 @@ jobs:
       - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
+          node-version: "18.x"
       - run: |
           pnpm install
           pnpm typecheck
@@ -67,7 +79,7 @@ jobs:
       - uses: pnpm/action-setup@v2.2.4
       - uses: actions/setup-node@v3
         with:
-          node-version: '18.x'
+          node-version: "18.x"
       - run: |
           pnpm install
           pnpm test -- --run
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -6,7 +6,6 @@ on:
       - main
 
 jobs:
-
   Release:
     # prevents this action from running on forks
     if: github.repository == 'manzt/anywidget'
diff --git a/.gitignore b/.gitignore
@@ -4,6 +4,7 @@ __pycache__/
 .eggs/*
 
 .ipynb_checkpoints/
+.mypy_cache/
 
 node_modules/
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -28,7 +28,7 @@ repos:
       - id: mypy
         # needed ignores will depend on what is in the environment
         # so with a more minimal environment here than the IDE
-        # we allow "unused" type ignore comments 
+        # we allow "unused" type ignore comments
         args: [--no-warn-unused-ignores]
         exclude: tests|docs
         # packages in the pre-commit env will determine what can be type checked
diff --git a/CITATION.cff b/CITATION.cff
@@ -12,13 +12,13 @@ authors:
     family-names: Manz
     email: trevor.j.manz@gmail.com
     affiliation: Harvard Medical School
-    orcid: 'https://orcid.org/0000-0001-7694-5164'
+    orcid: "https://orcid.org/0000-0001-7694-5164"
 identifiers:
   - type: doi
     value: 10.5281/zenodo.8010549
     description: Zenodo
-repository-code: 'https://github.com/manzt/anywidget'
-url: 'https://anywidget.dev'
+repository-code: "https://github.com/manzt/anywidget"
+url: "https://anywidget.dev"
 abstract: >-
   anywidget is a Python library that simplifies the creation
   and maintenance of Jupyter Widgets, making them more
diff --git a/anywidget/nbextension/extension.js b/anywidget/nbextension/extension.js
@@ -4,7 +4,7 @@ define(function () {
 	window.requirejs?.config({
 		map: {
 			"*": {
-				"anywidget": "nbextensions/anywidget/index",
+				anywidget: "nbextensions/anywidget/index",
 			},
 		},
 	});
diff --git a/docs/package.json b/docs/package.json
@@ -8,8 +8,7 @@
 		"check": "astro check && tsc",
 		"build": "astro build",
 		"preview": "astro preview",
-		"astro": "astro",
-		"format": "prettier --ignore-path=../.gitignore --use-tabs --write ."
+		"astro": "astro"
 	},
 	"dependencies": {
 		"@algolia/client-search": "^4.13.1",
@@ -33,8 +32,6 @@
 	"devDependencies": {
 		"astro": "^2.5.7",
 		"html-escaper": "^3.0.3",
-		"prettier": "^2.8.2",
-		"prettier-plugin-astro": "^0.7.2",
 		"shiki": "^0.14.1",
 		"vite": "^4.1.4"
 	}
diff --git a/docs/scripts/ipynb.mjs b/docs/scripts/ipynb.mjs
@@ -140,7 +140,7 @@ function widgetClientHtml(widgetState) {
 	<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
 	<script src="https://unpkg.com/@jupyter-widgets/html-manager@*/dist/embed-amd.js"></script>\n
 	<script type="application/vnd.jupyter.widget-state+json">${JSON.stringify(
-		widgetState
+		widgetState,
 	)}</script>\n`;
 }
 
diff --git a/docs/scripts/utils.mjs b/docs/scripts/utils.mjs
@@ -35,7 +35,7 @@ function appendForwardSlash(path) {
  */
 export function getFileInfo(id, config) {
 	const sitePathname = appendForwardSlash(
-		config.site ? new URL(config.base, config.site).pathname : config.base
+		config.site ? new URL(config.base, config.site).pathname : config.base,
 	);
 
 	// Try to grab the file's actual URL
diff --git a/docs/src/components/Header/Search.tsx b/docs/src/components/Header/Search.tsx
@@ -34,7 +34,7 @@ export default function Search() {
 			setIsOpen(true);
 			setInitialQuery(e.key);
 		},
-		[setIsOpen, setInitialQuery]
+		[setIsOpen, setInitialQuery],
 	);
 
 	useDocSearchKeyboardEvents({
@@ -106,7 +106,7 @@ export default function Search() {
 							});
 						}}
 					/>,
-					document.body
+					document.body,
 				)}
 		</>
 	);
diff --git a/docs/src/components/Header/ThemeToggleButton.css b/docs/src/components/Header/ThemeToggleButton.css
@@ -11,7 +11,9 @@
 
 .theme-toggle > label:focus-within {
 	outline: 2px solid transparent;
-	box-shadow: 0 0 0 0.08em var(--theme-accent), 0 0 0 0.12em white;
+	box-shadow:
+		0 0 0 0.08em var(--theme-accent),
+		0 0 0 0.12em white;
 }
 
 .theme-toggle > label {
diff --git a/docs/src/components/RightSidebar/TableOfContents.tsx b/docs/src/components/RightSidebar/TableOfContents.tsx
@@ -58,7 +58,7 @@ const TableOfContents: FunctionalComponent<{ headings: MarkdownHeading[] }> = ({
 
 		const headingsObserver = new IntersectionObserver(
 			setCurrent,
-			observerOptions
+			observerOptions,
 		);
 
 		// Observe all the headings in the main page content.
diff --git a/docs/src/pages/en/jupyter-widgets-the-good-parts.md b/docs/src/pages/en/jupyter-widgets-the-good-parts.md
@@ -20,7 +20,7 @@ that removes boilerplate and packaging details.
 ### Comparison with traditional Jupyter Widgets
 
 **anywidget** simplies creating your widget's front-end code. Its only requirement
-is that your widget front-end code is a valid [JavaScript module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) 
+is that your widget front-end code is a valid [JavaScript module](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
 and exports a function called `render`. This `render` function is similar to the traditional
 [`DOMWidgetView.render`](https://ipywidgets.readthedocs.io/en/8.0.2/examples/Widget%20Custom.html#Render-method).
 
diff --git a/docs/src/styles/index.css b/docs/src/styles/index.css
@@ -340,7 +340,8 @@ h2.heading {
 
 .header-link {
 	font-size: 1em;
-	transition: border-inline-start-color 100ms ease-out,
+	transition:
+		border-inline-start-color 100ms ease-out,
 		background-color 200ms ease-out;
 	border-left: 4px solid var(--theme-divider);
 }
diff --git a/package.json b/package.json
@@ -8,13 +8,17 @@
 		"version": "changeset version && pnpm install",
 		"release": "python -m build && changeset publish && twine upload dist/*",
 		"test": "vitest --environment=happy-dom",
-		"typecheck": "pnpm --parallel --recursive typecheck"
+		"typecheck": "pnpm --parallel --recursive typecheck",
+		"format": "prettier --ignore-path=.gitignore --use-tabs --write .",
+		"lint": "prettier --ignore-path=.gitignore --use-tabs --check ."
 	},
 	"devDependencies": {
 		"@changesets/cli": "^2.26.2",
 		"@svitejs/changesets-changelog-github-compact": "^1.1.0",
-		"esbuild": "^0.18.13",
+		"esbuild": "^0.18.15",
 		"happy-dom": "^10.5.2",
+		"prettier": "^3.0.0",
+		"prettier-plugin-astro": "^0.11.0",
 		"typescript": "^5.1.6",
 		"vitest": "^0.32.4"
 	},
diff --git a/packages/anywidget/CHANGELOG.md b/packages/anywidget/CHANGELOG.md
@@ -182,11 +182,11 @@
 
   /** @type {import("anywidget/types").Render<{ value: number }>} */
   export function render(view) {
-    let value = view.model.get("value");
-    //^ ? `number`
+  	let value = view.model.get("value");
+  	//^ ? `number`
 
-    view.model.set("value", "not-a-number");
-    // Error: Argument of type 'string' is not assignable to parameter of type 'number'. [2345]
+  	view.model.set("value", "not-a-number");
+  	// Error: Argument of type 'string' is not assignable to parameter of type 'number'. [2345]
   }
   ```
 
diff --git a/packages/anywidget/__tests__/widget.test.ts b/packages/anywidget/__tests__/widget.test.ts
@@ -77,11 +77,14 @@ class DummyManager extends baseManager.ManagerBase {
 	): Promise<any> {
 		let mod: Record<string, any> | undefined = {
 			"@jupyter-widgets/base": widgets,
-			"anywidget": anywidget,
+			anywidget: anywidget,
 		}[moduleName];
-		return mod?.[className] ?? (() => {
-			throw new Error(`Cannot find module ${moduleName}`);
-		})();
+		return (
+			mod?.[className] ??
+			(() => {
+				throw new Error(`Cannot find module ${moduleName}`);
+			})()
+		);
 	}
 
 	async _get_comm_info() {
@@ -101,14 +104,17 @@ describe("AnyModel", async () => {
 	it("loads", async () => {
 		let widget_manager = new DummyManager();
 
-		let model = await widget_manager.new_widget({
-			model_name: "AnyModel",
-			model_module: "anywidget",
-			model_module_version: "0.1.0",
-			view_name: "AnyView",
-			view_module: "anywidget",
-			view_module_version: "0.1.0",
-		}, { _esm });
+		let model = await widget_manager.new_widget(
+			{
+				model_name: "AnyModel",
+				model_module: "anywidget",
+				model_module_version: "0.1.0",
+				view_name: "AnyView",
+				view_module: "anywidget",
+				view_module_version: "0.1.0",
+			},
+			{ _esm },
+		);
 
 		expect(model).toBeInstanceOf(anywidget.AnyModel);
 	});
diff --git a/packages/anywidget/src/widget.js b/packages/anywidget/src/widget.js
@@ -83,9 +83,7 @@ async function load_esm(esm) {
 	if (is_href(esm)) {
 		return import(/* webpackIgnore: true */ esm);
 	}
-	let url = URL.createObjectURL(
-		new Blob([esm], { type: "text/javascript" }),
-	);
+	let url = URL.createObjectURL(new Blob([esm], { type: "text/javascript" }));
 	let widget;
 	try {
 		widget = await import(/* webpackIgnore: true */ url);
@@ -157,9 +155,9 @@ export default function ({ DOMWidgetModel, DOMWidgetView }) {
 				if (!id) return;
 				console.debug(`[anywidget] esm hot updated: ${id}`);
 
-				let views = (/** @type {unknown} */ (Object.values(this.views ?? {})));
+				let views = /** @type {unknown} */ (Object.values(this.views ?? {}));
 
-				for await (let view of (/** @type {Promise<AnyView>[]} */ (views))) {
+				for await (let view of /** @type {Promise<AnyView>[]} */ (views)) {
 					// load updated esm
 					let widget = await load_esm(this.get("_esm"));
 
diff --git a/packages/types/index.d.ts b/packages/types/index.d.ts
@@ -24,7 +24,8 @@ export interface AnyModel<T extends ObjectHash = ObjectHash> {
 	): void;
 	on<K extends `change:${keyof T & string}`>(
 		eventName: K,
-		callback: K extends `change:${infer Key}` ? ChangeEventHandler<T[Key]>
+		callback: K extends `change:${infer Key}`
+			? ChangeEventHandler<T[Key]>
 			: never,
 	): void;
 	on<K extends `change:${string}`>(
@@ -48,5 +49,3 @@ export interface RenderContext<T extends ObjectHash = ObjectHash> {
 export interface Render<T extends ObjectHash = ObjectHash> {
 	(context: RenderContext<T>): Awaitable<void | (() => Awaitable<void>)>;
 }
-
-
diff --git a/packages/types/package.json b/packages/types/package.json
@@ -1,18 +1,18 @@
 {
-  "name": "@anywidget/types",
-  "type": "module",
-  "version": "0.1.3",
-  "description": "utility types for anywidget",
-  "main": "index.js",
-  "types": "index.d.ts",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "import": "./index.js",
-      "require": "./index.cjs"
-    }
-  },
-  "scripts": {
-    "typecheck": "vitest typecheck --run"
-  }
+	"name": "@anywidget/types",
+	"type": "module",
+	"version": "0.1.3",
+	"description": "utility types for anywidget",
+	"main": "index.js",
+	"types": "index.d.ts",
+	"exports": {
+		".": {
+			"types": "./index.d.ts",
+			"import": "./index.js",
+			"require": "./index.cjs"
+		}
+	},
+	"scripts": {
+		"typecheck": "vitest typecheck --run"
+	}
 }
diff --git a/packages/types/test-d.ts b/packages/types/test-d.ts
@@ -2,7 +2,7 @@ import { describe, it, expectTypeOf } from "vitest";
 import type { AnyModel } from "./index.js";
 
 declare let model: AnyModel;
-declare let typedModel: AnyModel<{ value: number, name: string }>;
+declare let typedModel: AnyModel<{ value: number; name: string }>;
 
 describe("AnyModel.get", () => {
 	it("uses strict types when model is provided", () => {
diff --git a/packages/types/tsconfig.json b/packages/types/tsconfig.json
@@ -2,7 +2,7 @@
 	"extends": "../../tsconfig.json",
 	"compilerOptions": {
 		"moduleResolution": "node",
-		"esModuleInterop": true,
+		"esModuleInterop": true
 		// TODO: We want to typecheck index.d.ts but not the
 		// rest of the node_modules.
 		// "skipLibCheck": false
diff --git a/packages/vite/README.md b/packages/vite/README.md
@@ -17,7 +17,7 @@ import anywidget from "@anywidget/vite";
 
 export default defineConfig({
 	plugins: [anywidget()],
-})
+});
 ```
 
 Read the [docs](https://anywidget.dev/en/bundling/#vite) to learn more
@@ -26,4 +26,3 @@ about configuring Vite with **anywidget** for your project.
 ## License
 
 MIT
-
diff --git a/packages/vite/package.json b/packages/vite/package.json
diff --git a/packages/vite/pnpm-lock.yaml b/packages/vite/pnpm-lock.yaml
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

Original file line number	Diff line number	Diff line change
`@@ -140,7 +140,7 @@ function widgetClientHtml(widgetState) {`
`140`	`140`	`<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>`
`141`	`141`	`<script src="https://unpkg.com/@jupyter-widgets/html-manager@*/dist/embed-amd.js"></script>\n`
`142`	`142`	`<script type="application/vnd.jupyter.widget-state+json">${JSON.stringify(`
`143`		`- widgetState`
	`143`	`+ widgetState,`
`144`	`144`	)}</script>\n`;
`145`	`145`	`}`
`146`	`146`