js-draw 0.18.0 → 0.18.1

package/.github/pull_request_template.md

@@ -1,15 +0,0 @@
-# Summary
-<!-- A description of the changes made by this PR. -->
-
-# Testing <!-- (if applicable) -->
-<!--
-	Describe what changes have automated tests and what changes don't. If changes lack automated tests, please describe how it can be verified that changes made by this pull request work as expected.
--->
-
-# Screenshots/other information
-<!--
-	If applicable, please include screenshots/screen recordings/other information that may help contributors review this pull request.
--->
-
-
-Resolves #[issue number here].

package/.github/workflows/firebase-hosting-merge.yml

@@ -1,34 +0,0 @@
-# This file was auto-generated by the Firebase CLI
-# https://github.com/firebase/firebase-tools
-
-name: Deploy to Firebase Hosting on merge
-'on':
-  push:
-    branches:
-      - 'main'
-
-# See https://github.com/FirebaseExtended/action-hosting-deploy/issues/198
-permissions:
-  contents: read
-
-jobs:
-  build_and_deploy:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install dependencies
-        run: yarn install
-      - name: Test imports
-        run: yarn dist-test
-      - name: Run tests
-        run: yarn test
-      - name: Lint
-        run: yarn lint-ci
-      - name: Build
-        run: cd docs/example && yarn install && yarn build
-      - uses: FirebaseExtended/action-hosting-deploy@v0
-        with:
-          repoToken: '${{ secrets.GITHUB_TOKEN }}'
-          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_JS_DRAW }}'
-          channelId: live
-          projectId: js-draw

package/.github/workflows/firebase-hosting-pull-request.yml

@@ -1,34 +0,0 @@
-# This file was auto-generated by the Firebase CLI
-# https://github.com/firebase/firebase-tools
-
-name: Deploy to Firebase Hosting on PR
-'on': pull_request
-
-# See https://github.com/FirebaseExtended/action-hosting-deploy/issues/198
-# and https://github.com/FirebaseExtended/action-hosting-deploy/issues/108#issuecomment-1036024111
-permissions:
-  contents: read
-  pull-requests: write
-  checks: write
-
-jobs:
-  build_and_preview:
-    if: '${{ github.event.pull_request.head.repo.full_name == github.repository }}'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-      - name: Install dependencies
-        run: yarn install
-      - name: Test imports
-        run: yarn dist-test
-      - name: Run tests
-        run: yarn test
-      - name: Lint
-        run: yarn lint-ci
-      - name: Build
-        run: cd docs/example && yarn install && yarn build
-      - uses: FirebaseExtended/action-hosting-deploy@v0
-        with:
-          repoToken: '${{ secrets.GITHUB_TOKEN }}'
-          firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_JS_DRAW }}'
-          projectId: js-draw

package/.github/workflows/github-pages.yml

@@ -1,58 +0,0 @@
-# Created on GitHub
-
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
-
-on:
-  # Runs on pushes targeting the default branch
-  push:
-    branches: ["main"]
-
-  # Allows you to run this workflow manually from the Actions tab
-  workflow_dispatch:
-
-# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
-permissions:
-  contents: read
-  pages: write
-  id-token: write
-
-# Allow one concurrent deployment
-concurrency:
-  group: "pages"
-  cancel-in-progress: true
-
-jobs:
-  # Single deploy job since we're just deploying
-  deploy:
-    environment:
-      name: github-pages
-      url: ${{ steps.deployment.outputs.page_url }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-      - name: Install dependencies
-        run: yarn install
-      - name: Test imports
-        run: yarn dist-test
-      - name: Run tests
-        run: yarn test
-      - name: Lint
-        run: yarn lint-ci
-      - name: Build documentation
-        run: yarn doc
-      - name: Build
-        run: cd docs/example && yarn install && yarn build
-      - name: Remove flies that don't need to be uploaded
-        run: cd docs/ && rm -rf example*/node_modules/
-      - name: Setup Pages
-        uses: actions/configure-pages@v2
-      - name: Upload artifact
-        uses: actions/upload-pages-artifact@v1
-        with:
-          # Upload just the docs folder
-          path: './docs/'
-      - name: Deploy to GitHub Pages
-        id: deployment
-        uses: actions/deploy-pages@v1

package/.husky/pre-commit

@@ -1,4 +0,0 @@
-#!/usr/bin/env sh
-. "$(dirname -- "$0")/_/husky.sh"
-
-yarn lint-staged

package/build_tools/BundledFile.ts

@@ -1,167 +0,0 @@
-// This file is taken from Joplin: https://github.com/laurent22/joplin
-// js-draw was originally created as a part of a pull request for joplin. This
-// is part of the functionality from Joplin it requires.
-
-import { dirname, extname, basename } from 'path';
-import TerserPlugin from 'terser-webpack-plugin';
-
-import webpack from 'webpack';
-
-export default class BundledFile {
-	private readonly bundleBaseName: string;
-	private readonly rootFileDirectory: string;
-	private readonly outputDirectory: string;
-	private readonly outputFilename: string;
-
-	public constructor(
-		public readonly bundleName: string,
-		private readonly sourceFilePath: string,
-		outputFilepath?: string,
-	) {
-		this.rootFileDirectory = dirname(sourceFilePath);
-		this.bundleBaseName = basename(sourceFilePath, extname(sourceFilePath));
-
-		if (outputFilepath) {
-			this.outputDirectory = dirname(outputFilepath);
-			this.outputFilename = basename(outputFilepath);
-		} else {
-			this.outputDirectory = this.rootFileDirectory;
-			this.outputFilename = `${this.bundleBaseName}.bundle.js`;
-		}
-	}
-
-	private getWebpackOptions(mode: 'production' | 'development'): webpack.Configuration {
-		const config: webpack.Configuration = {
-			mode,
-			entry: this.sourceFilePath,
-			output: {
-				path: this.outputDirectory,
-				filename: this.outputFilename,
-
-				library: {
-					type: 'window',
-					name: this.bundleName,
-				},
-			},
-			// See https://webpack.js.org/guides/typescript/
-			module: {
-				rules: [
-					{
-						// Include .tsx to include react components
-						test: /\.tsx?$/i,
-						use: 'ts-loader',
-						exclude: /node_modules/,
-					},
-					{
-						test: /\.css$/i,
-						use: ['style-loader', 'css-loader'],
-					},
-				],
-			},
-			optimization: {
-				minimizer: [
-					// Don't create separate files for comments.
-					// See https://stackoverflow.com/a/65650316/17055750
-					new TerserPlugin({
-						extractComments: false,
-					}),
-				],
-			},
-			// Increase the minimum size required
-			// to trigger warnings.
-			// See https://stackoverflow.com/a/53517149/17055750
-			performance: {
-				maxAssetSize: 2_000_000, // 2-ish MiB
-				maxEntrypointSize: 2_000_000,
-			},
-			resolve: {
-				extensions: ['.tsx', '.ts', '.js'],
-			},
-		};
-
-		return config;
-	}
-
-	private handleErrors(err: Error | undefined | null, stats: webpack.Stats | undefined): boolean {
-		let failed = false;
-
-		if (err) {
-			console.error(`Error: ${err.name}`, err.message, err.stack);
-			failed = true;
-		} else if (stats?.hasErrors() || stats?.hasWarnings()) {
-			const data = stats.toJson();
-
-			if (data.warnings && data.warningsCount) {
-				console.warn('Warnings: ', data.warningsCount);
-				for (const warning of data.warnings) {
-					// Stack contains the message
-					if (warning.stack) {
-						console.warn(warning.stack);
-					} else {
-						console.warn(warning.message);
-					}
-				}
-			}
-			if (data.errors && data.errorsCount) {
-				console.error('Errors: ', data.errorsCount);
-				for (const error of data.errors) {
-					if (error.stack) {
-						console.error(error.stack);
-					} else {
-						console.error(error.message);
-					}
-					console.error();
-				}
-
-				failed = true;
-			}
-		}
-
-		return failed;
-	}
-
-	// Create a minified JS file in the same directory as `this.sourceFilePath` with
-	// the same name.
-	public build() {
-		const compiler = webpack(this.getWebpackOptions('production'));
-		return new Promise<void>((resolve, reject) => {
-			console.info(`Building bundle: ${this.bundleName}...`);
-
-			compiler.run((err, stats) => {
-				let failed = this.handleErrors(err, stats);
-
-				// Clean up.
-				compiler.close(async (error) => {
-					if (error) {
-						console.error('Error cleaning up:', error);
-						failed = true;
-					}
-					if (!failed) {
-						console.log('☑ Done building! ☑');
-						resolve();
-					} else {
-						reject();
-					}
-				});
-			});
-		});
-	}
-
-	public startWatching() {
-		const compiler = webpack(this.getWebpackOptions('development'));
-		const watchOptions = {
-			ignored: [
-				'**/node_modules',
-				'**/dist',
-			],
-		};
-
-		console.info('Watching bundle: ', this.bundleName);
-		compiler.watch(watchOptions, async (err, stats) => {
-			const failed = this.handleErrors(err, stats);
-			if (!failed) {
-				console.log('☑ Built! ☑');
-			}
-		});
-	}
-}

package/build_tools/buildTranslationTemplate.ts

@@ -1,121 +0,0 @@
-
-import * as fs from 'fs';
-import * as path from 'path';
-
-import { defaultEditorLocalization } from '../src/localization';
-
-// Adds markdown formatting to format text like code.
-const codeFormat = (text: string) => {
-	let maxConsecutiveBackticks = 0;
-
-	// Find the longest number of consecutive backticks — we need to have more
-	// than that for the delimiters.
-	const backtickRuns = text.matchAll(/[`]+/g);
-	for (const backticks of backtickRuns) {
-		if (backticks.length > maxConsecutiveBackticks) {
-			maxConsecutiveBackticks = backticks.length;
-		}
-	}
-
-	let codeStartEnd = '';
-	for (let i = 0; i < maxConsecutiveBackticks + 1; i++) {
-		codeStartEnd += '`';
-	}
-
-	// If the text already starts with a `, add a space to prevent the
-	// markdown parser from treating it as part of the delimiter.
-	if (text.startsWith('`')) {
-		text = ' ' + text;
-	}
-
-	if (text.endsWith('`')) {
-		text = text + ' ';
-	}
-
-	return `${codeStartEnd}${text}${codeStartEnd}`;
-};
-
-const collapseSpaces = (text: string) => text.replace(/\s+/g, ' ');
-
-const generateTranslationTemplate = () => {
-	const bodyContentLines: string[] = [];
-
-	const addInput = (
-		type: string, id: string, attrs: Record<string, string>, required: boolean = false
-	) => {
-		const lines: string[] = [];
-		lines.push(`  - type: ${type}`);
-		lines.push(`    id: ${id}`);
-		lines.push('    attributes:');
-
-		for (const key in attrs) {
-			const value = `${attrs[key]}`;
-
-			const escapedValue = value.replace(/[\\]/g, '\\\\').replace(/"/g, '\\"');
-			lines.push(`      ${key}: "${escapedValue}"`);
-		}
-
-		lines.push('    validations:');
-		lines.push(`      required: ${required}`);
-
-		bodyContentLines.push(...lines);
-	};
-
-	const addLabel = (text: string) => {
-		bodyContentLines.push('  - type: markdown');
-		bodyContentLines.push('    attributes:');
-		bodyContentLines.push('      value: |');
-		bodyContentLines.push('        ' + text);
-	};
-
-	addLabel(collapseSpaces(`
-		Thank you for taking the time to translate \`js-draw\`! If you don't have time to translate
-		all of the strings below, feel free to submit an incomplete translation and edit it later.
-		Use this template to update an existing translation or to create a new translation.
-	`));
-
-	addLabel(collapseSpaces(`
-		(Optional) If you would like to submit a pull request that applies this translation, 
-		note that existing translations are present in
-		[src/localizations/](https://github.com/personalizedrefrigerator/js-draw/tree/main/src/localizations).
-	`));
-
-	addInput('input', 'language-name', {
-		label: 'Language',
-		description: 'The name of the language to translate to in English (e.g. Spanish)',
-	}, true);
-
-	for (const key in defaultEditorLocalization) {
-		const englishTranslation = `${(defaultEditorLocalization as any)[key]}`;
-		addInput('input', `translation-${key}`, {
-			label: `${key}`,
-			description: `Translate ${codeFormat(englishTranslation)}.`,
-			placeholder: englishTranslation,
-		});
-	}
-
-	addInput('textarea', 'additional-comments', {
-		label: 'Additional information',
-		placeholder: 'Any additional information/comments on the translation can go here.',
-	});
-
-	return `name: Translation
-# This template is auto-generated by build_tools/buildTranslationTemplate.ts
-# Do not modify it directly.
-description: Translate the editor to a new language!
-title: "[Translation]: <language>"
-labels: [localization]
-assignees: []
-body:
-${bodyContentLines.join('\n')}`;
-};
-
-const template = generateTranslationTemplate();
-
-// According to https://stackoverflow.com/a/13650454, fs should
-// be able to handle forward and back slashes (both) on Windows (so extra
-// path logic shouldn't be needed here.)
-const rootDir = path.dirname(__dirname);
-const translationTempaltePath = path.join(rootDir, '.github/ISSUE_TEMPLATE/translation.yml');
-
-fs.writeFileSync(translationTempaltePath, template);

package/build_tools/bundle.ts

@@ -1,11 +0,0 @@
-import { dirname } from 'path';
-import BundledFile from './BundledFile';
-
-const rootDir = dirname(__dirname);
-const mainBundle = new BundledFile(
-	'jsdraw',
-	`${rootDir}/src/bundle/bundled.ts`,
-	`${rootDir}/dist/bundle.js`,
-);
-
-void mainBundle.build();

package/build_tools/postDist.ts

@@ -1,71 +0,0 @@
-
-import { readdir, stat, rename, readFile, writeFile, unlink } from 'fs/promises';
-import path from 'path';
-
-// Script to be run after building JavaScript files from TypeScript.
-// TODO: This is very hacky.
-// TODO: [Use the TypeScript Compiler API instead.](https://github.com/microsoft/TypeScript/wiki/Using-the-Compiler-API)
-
-// Iterates over every JavaScript file in [directory].
-const forEachFile = async (directory: string, processFile: (filePath: string)=>Promise<void>) => {
-	const files = await readdir(directory);
-
-	await Promise.all(files.map(async (file) => {
-		const filePath = path.join(directory, file);
-		const stats = await stat(filePath);
-
-		if (stats.isDirectory()) {
-			await forEachFile(filePath, processFile);
-		} else if (stats.isFile()) {
-			await processFile(filePath);
-		} else {
-			throw new Error('Unknown file type!');
-		}
-	}));
-};
-
-const removeFiles = async (directory: string, filePattern: RegExp) => {
-	await forEachFile(directory, async (filePath: string) => {
-		if (!filePath.match(filePattern)) {
-			return;
-		}
-
-		await unlink(filePath);
-	});
-};
-
-const main = async () => {
-	const rootDir = path.dirname(__dirname);
-	const cjsPath = `${rootDir}/dist/cjs`;
-	const mjsPath = `${rootDir}/dist/mjs`;
-
-	const testPattern = /\.test\.js$/;
-	await removeFiles(cjsPath, testPattern);
-	await removeFiles(mjsPath, testPattern);
-
-	// We need to replace imports in ESM files.
-	await forEachFile(mjsPath, async (filePath: string) => {
-		if (!filePath.endsWith('.js')) {
-			return;
-		}
-
-		// Rename
-		const newPath = filePath.replace(/\.js$/, '.mjs');
-		await rename(filePath, newPath);
-
-		// Change imports from
-		//   import foo from './bar'
-		// to
-		//   import foo from './bar.mjs'
-		// and exports similarly.
-		let contents = await readFile(newPath, { encoding: 'utf-8' });
-
-		// TODO: Switch to using the TypeScript compiler API. This has the danger of changing imports
-		// in multi-line strings.
-		contents = contents.replace(/([\n]|^)(import|export)(.*)from\s+(['"])(\.*\/[^\n]+)(['"])/g, '$1$2 $3 from $4$5.mjs$6');
-
-		await writeFile(newPath, contents);
-	});
-};
-
-main();

package/dist/cjs/build_tools/BundledFile.d.ts

@@ -1,13 +0,0 @@
-export default class BundledFile {
-    readonly bundleName: string;
-    private readonly sourceFilePath;
-    private readonly bundleBaseName;
-    private readonly rootFileDirectory;
-    private readonly outputDirectory;
-    private readonly outputFilename;
-    constructor(bundleName: string, sourceFilePath: string, outputFilepath?: string);
-    private getWebpackOptions;
-    private handleErrors;
-    build(): Promise<void>;
-    startWatching(): void;
-}