|
|
@@ -1,536 +0,0 @@
|
|
|
-// Copyright 2019-2021 Tauri Programme within The Commons Conservancy
|
|
|
-// SPDX-License-Identifier: Apache-2.0
|
|
|
-// SPDX-License-Identifier: MIT
|
|
|
-
|
|
|
-'use strict'
|
|
|
-
|
|
|
-/* eslint-disable @typescript-eslint/restrict-template-expressions, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-return, @typescript-eslint/no-unsafe-call */
|
|
|
-
|
|
|
-/**
|
|
|
- * This is a module that takes an original image and resizes
|
|
|
- * it to common icon sizes and will put them in a folder.
|
|
|
- * It will retain transparency and can make special file
|
|
|
- * types. You can control the settings.
|
|
|
- *
|
|
|
- * @module tauricon
|
|
|
- * @exports tauricon
|
|
|
- * @author Daniel Thompson-Yvetot
|
|
|
- * @license MIT
|
|
|
- */
|
|
|
-
|
|
|
-import * as fsExtra from 'fs-extra'
|
|
|
-import imagemin, { Plugin } from 'imagemin'
|
|
|
-import optipng from 'imagemin-optipng'
|
|
|
-import zopfli from 'imagemin-zopfli'
|
|
|
-import isPng from 'is-png'
|
|
|
-import path from 'path'
|
|
|
-import * as png2icons from 'png2icons'
|
|
|
-import { readChunk } from 'read-chunk'
|
|
|
-import sharp from 'sharp'
|
|
|
-import { appDir, tauriDir } from '../helpers/app-paths'
|
|
|
-import logger from '../helpers/logger'
|
|
|
-import * as settings from '../helpers/tauricon.config'
|
|
|
-import chalk from 'chalk'
|
|
|
-import { createRequire } from 'module'
|
|
|
-
|
|
|
-// @ts-expect-error
|
|
|
-const { access, ensureDir, ensureFileSync, writeFileSync } = fsExtra.default
|
|
|
-
|
|
|
-const require = createRequire(import.meta.url)
|
|
|
-// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
|
-const { version } = require('../../package.json')
|
|
|
-// eslint-disable-next-line @typescript-eslint/no-var-requires
|
|
|
-const pngToIco = require('png-to-ico')
|
|
|
-
|
|
|
-const log = logger('app:spawn')
|
|
|
-const warn = logger('app:spawn', chalk.red)
|
|
|
-
|
|
|
-let image: boolean | sharp.Sharp = false
|
|
|
-let spinnerInterval: NodeJS.Timeout | null = null
|
|
|
-
|
|
|
-const exists = async function (file: string | Buffer): Promise<boolean> {
|
|
|
- try {
|
|
|
- await access(file)
|
|
|
- return true
|
|
|
- } catch (err) {
|
|
|
- return false
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-/**
|
|
|
- * This is the first call that attempts to memoize the sharp(src).
|
|
|
- * If the source image cannot be found or if it is not a png, it
|
|
|
- * is a failsafe that will exit or throw.
|
|
|
- *
|
|
|
- * @param {string} src - a folder to target
|
|
|
- * @exits {error} if not a png, if not an image
|
|
|
- */
|
|
|
-const checkSrc = async (src: string): Promise<boolean | sharp.Sharp> => {
|
|
|
- if (image !== false) {
|
|
|
- return image
|
|
|
- } else {
|
|
|
- const srcExists = await exists(src)
|
|
|
- if (!srcExists) {
|
|
|
- image = false
|
|
|
- if (spinnerInterval) clearInterval(spinnerInterval)
|
|
|
- warn('[ERROR] Source image for tauricon not found')
|
|
|
- process.exit(1)
|
|
|
- } else {
|
|
|
- const buffer = await readChunk(src, { startPosition: 0, length: 8 })
|
|
|
- if (isPng(buffer)) {
|
|
|
- image = sharp(src)
|
|
|
- const meta = await image.metadata()
|
|
|
- if (!meta.hasAlpha || meta.channels !== 4) {
|
|
|
- if (spinnerInterval) clearInterval(spinnerInterval)
|
|
|
- warn('[ERROR] Source png for tauricon is not transparent')
|
|
|
- process.exit(1)
|
|
|
- }
|
|
|
-
|
|
|
- // just because PNG is sneaky, lets look at the
|
|
|
- // individual pixels for something weird
|
|
|
- const stats = await image.stats()
|
|
|
- if (stats.isOpaque) {
|
|
|
- if (spinnerInterval) clearInterval(spinnerInterval)
|
|
|
- warn(
|
|
|
- '[ERROR] Source png for tauricon could not be detected as transparent'
|
|
|
- )
|
|
|
- process.exit(1)
|
|
|
- }
|
|
|
-
|
|
|
- return image
|
|
|
- } else {
|
|
|
- image = false
|
|
|
- if (spinnerInterval) clearInterval(spinnerInterval)
|
|
|
- warn('[ERROR] Source image for tauricon is not a png')
|
|
|
- process.exit(1)
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-/**
|
|
|
- * Sort the folders in the current job for unique folders.
|
|
|
- *
|
|
|
- * @param {object} options - a subset of the settings
|
|
|
- * @returns {array} folders
|
|
|
- */
|
|
|
-// TODO: proper type of options and folders
|
|
|
-const uniqueFolders = (options: { [index: string]: any }): any[] => {
|
|
|
- let folders = []
|
|
|
- for (const type in options) {
|
|
|
- const option = options[String(type)]
|
|
|
- if (option.folder) {
|
|
|
- folders.push(option.folder)
|
|
|
- }
|
|
|
- }
|
|
|
- // TODO: is compare argument required?
|
|
|
- // eslint-disable-next-line @typescript-eslint/require-array-sort-compare
|
|
|
- folders = folders.sort().filter((x, i, a) => !i || x !== a[i - 1])
|
|
|
- return folders
|
|
|
-}
|
|
|
-
|
|
|
-/**
|
|
|
- * Turn a hex color (like #212342) into r,g,b values
|
|
|
- *
|
|
|
- * @param {string} hex - hex colour
|
|
|
- * @returns {array} r,g,b
|
|
|
- */
|
|
|
-const hexToRgb = (
|
|
|
- hex: string
|
|
|
-): { r: number; g: number; b: number } | undefined => {
|
|
|
- // https://stackoverflow.com/questions/5623838/rgb-to-hex-and-hex-to-rgb
|
|
|
- // Expand shorthand form (e.g. "03F") to full form (e.g. "0033FF")
|
|
|
- const shorthandRegex = /^#?([a-f\d])([a-f\d])([a-f\d])$/i
|
|
|
- hex = hex.replace(
|
|
|
- shorthandRegex,
|
|
|
- function (m: string, r: string, g: string, b: string) {
|
|
|
- return r + r + g + g + b + b
|
|
|
- }
|
|
|
- )
|
|
|
-
|
|
|
- const result = /^#?([a-f\d]{2})([a-f\d]{2})([a-f\d]{2})$/i.exec(hex)
|
|
|
- return result
|
|
|
- ? {
|
|
|
- r: parseInt(result[1], 16),
|
|
|
- g: parseInt(result[2], 16),
|
|
|
- b: parseInt(result[3], 16)
|
|
|
- }
|
|
|
- : undefined
|
|
|
-}
|
|
|
-
|
|
|
-/**
|
|
|
- * validate image and directory
|
|
|
- */
|
|
|
-const validate = async (
|
|
|
- src: string,
|
|
|
- target: string
|
|
|
-): Promise<boolean | sharp.Sharp> => {
|
|
|
- if (target !== undefined) {
|
|
|
- await ensureDir(target)
|
|
|
- }
|
|
|
- const res = await checkSrc(src)
|
|
|
- return res
|
|
|
-}
|
|
|
-
|
|
|
-// TODO: should take end param?
|
|
|
-/**
|
|
|
- * Log progress in the command line
|
|
|
- *
|
|
|
- * @param {boolean} end
|
|
|
- */
|
|
|
-const progress = (msg: string): void => {
|
|
|
- process.stdout.write(` ${msg} \r`)
|
|
|
-}
|
|
|
-
|
|
|
-/**
|
|
|
- * Create a spinner on the command line
|
|
|
- *
|
|
|
- * @example
|
|
|
- *
|
|
|
- * const spinnerInterval = spinner()
|
|
|
- * // later
|
|
|
- * clearInterval(spinnerInterval)
|
|
|
- */
|
|
|
-const spinner = (): NodeJS.Timeout | null => {
|
|
|
- if ('CI' in process.env || process.argv.some((arg) => arg === '--ci')) {
|
|
|
- return null
|
|
|
- }
|
|
|
- return setInterval(() => {
|
|
|
- process.stdout.write('/ \r')
|
|
|
- setTimeout(() => {
|
|
|
- process.stdout.write('- \r')
|
|
|
- setTimeout(() => {
|
|
|
- process.stdout.write('\\ \r')
|
|
|
- setTimeout(() => {
|
|
|
- process.stdout.write('| \r')
|
|
|
- }, 100)
|
|
|
- }, 100)
|
|
|
- }, 100)
|
|
|
- }, 500)
|
|
|
-}
|
|
|
-
|
|
|
-const tauricon = {
|
|
|
- validate: async function (src: string, target: string) {
|
|
|
- await validate(src, target)
|
|
|
- return typeof image === 'object'
|
|
|
- },
|
|
|
- version: function () {
|
|
|
- return version
|
|
|
- },
|
|
|
- make: async function (
|
|
|
- src: string | undefined,
|
|
|
- target: string = path.resolve(tauriDir, 'icons'),
|
|
|
- strategy: string,
|
|
|
- // TODO: proper type for options
|
|
|
- options: { [index: string]: any }
|
|
|
- ) {
|
|
|
- if (!src) {
|
|
|
- src = path.resolve(appDir, 'app-icon.png')
|
|
|
- }
|
|
|
- spinnerInterval = spinner()
|
|
|
- options = options || settings.options.tauri
|
|
|
- progress(`Building Tauri icns and ico from "${src}"`)
|
|
|
- await this.validate(src, target)
|
|
|
- await this.icns(src, target, options, strategy)
|
|
|
- progress('Building Tauri png icons')
|
|
|
- await this.build(src, target, options)
|
|
|
- if (strategy) {
|
|
|
- progress(`Minifying assets with ${strategy}`)
|
|
|
- await this.minify(target, options, strategy, 'batch')
|
|
|
- } else {
|
|
|
- log('no minify strategy')
|
|
|
- }
|
|
|
- progress('Tauricon Finished')
|
|
|
- if (spinnerInterval) clearInterval(spinnerInterval)
|
|
|
- return true
|
|
|
- },
|
|
|
-
|
|
|
- /**
|
|
|
- * Creates a set of images according to the subset of options it knows about.
|
|
|
- *
|
|
|
- * @param {string} src - image location
|
|
|
- * @param {string} target - where to drop the images
|
|
|
- * @param {object} options - js object that defines path and sizes
|
|
|
- */
|
|
|
- build: async function (
|
|
|
- src: string,
|
|
|
- target: string,
|
|
|
- // TODO: proper type for options
|
|
|
- options: { [index: string]: any }
|
|
|
- ) {
|
|
|
- await this.validate(src, target)
|
|
|
- const sharpSrc = sharp(src) // creates the image object
|
|
|
- const buildify2 = async function (
|
|
|
- pvar: [string, number, number]
|
|
|
- ): Promise<void> {
|
|
|
- try {
|
|
|
- const pngImage = sharpSrc.resize(pvar[1], pvar[1])
|
|
|
- if (pvar[2]) {
|
|
|
- // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, @typescript-eslint/no-unsafe-argument
|
|
|
- const rgb = hexToRgb(options.background_color) || {
|
|
|
- r: undefined,
|
|
|
- g: undefined,
|
|
|
- b: undefined
|
|
|
- }
|
|
|
- pngImage.flatten({
|
|
|
- background: { r: rgb.r, g: rgb.g, b: rgb.b, alpha: 1 }
|
|
|
- })
|
|
|
- }
|
|
|
- pngImage.png()
|
|
|
- await pngImage.toFile(pvar[0])
|
|
|
- } catch (err) {
|
|
|
- warn(err)
|
|
|
- }
|
|
|
- }
|
|
|
-
|
|
|
- let output
|
|
|
- const folders = uniqueFolders(options)
|
|
|
- // eslint-disable-next-line @typescript-eslint/no-for-in-array
|
|
|
- for (const n in folders) {
|
|
|
- const folder = folders[Number(n)]
|
|
|
- // make the folders first
|
|
|
- // TODO: should this be ensureDirSync?
|
|
|
- // eslint-disable-next-line @typescript-eslint/no-floating-promises
|
|
|
- ensureDir(`${target}${path.sep}${folder}`)
|
|
|
- }
|
|
|
- for (const optionKey in options) {
|
|
|
- const option = options[String(optionKey)]
|
|
|
- // chain up the transforms
|
|
|
- for (const sizeKey in option.sizes) {
|
|
|
- const size = option.sizes[String(sizeKey)]
|
|
|
- if (!option.splash) {
|
|
|
- const dest = `${target}/${option.folder}`
|
|
|
- if (option.infix === true) {
|
|
|
- output = `${dest}${path.sep}${option.prefix}${size}x${size}${option.suffix}`
|
|
|
- } else {
|
|
|
- output = `${dest}${path.sep}${option.prefix}${option.suffix}`
|
|
|
- }
|
|
|
- const pvar: [string, number, number] = [
|
|
|
- output,
|
|
|
- size,
|
|
|
- option.background
|
|
|
- ]
|
|
|
- await buildify2(pvar)
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
- },
|
|
|
- /**
|
|
|
- * Creates a set of splash images (COMING SOON!!!)
|
|
|
- *
|
|
|
- * @param {string} src - icon location
|
|
|
- * @param {string} splashSrc - splashscreen location
|
|
|
- * @param {string} target - where to drop the images
|
|
|
- * @param {object} options - js object that defines path and sizes
|
|
|
- */
|
|
|
- splash: async function (
|
|
|
- src: string,
|
|
|
- splashSrc: string,
|
|
|
- target: string,
|
|
|
- // TODO: proper type for options
|
|
|
- options: { [index: string]: any }
|
|
|
- ) {
|
|
|
- let output
|
|
|
- let block = false
|
|
|
- // eslint-disable-next-line @typescript-eslint/prefer-nullish-coalescing, @typescript-eslint/no-unsafe-argument
|
|
|
- const rgb = hexToRgb(options.background_color) || {
|
|
|
- r: undefined,
|
|
|
- g: undefined,
|
|
|
- b: undefined
|
|
|
- }
|
|
|
-
|
|
|
- // three options
|
|
|
- // options: splashscreen_type [generate | overlay | pure]
|
|
|
- // - generate (icon + background color) DEFAULT
|
|
|
- // - overlay (icon + splashscreen)
|
|
|
- // - pure (only splashscreen)
|
|
|
-
|
|
|
- let sharpSrc
|
|
|
- if (splashSrc === src) {
|
|
|
- // prevent overlay or pure
|
|
|
- block = true
|
|
|
- }
|
|
|
- if (block || options.splashscreen_type === 'generate') {
|
|
|
- await this.validate(src, target)
|
|
|
- if (!image) {
|
|
|
- process.exit(1)
|
|
|
- }
|
|
|
- sharpSrc = sharp(src)
|
|
|
- sharpSrc
|
|
|
- .extend({
|
|
|
- top: 726,
|
|
|
- bottom: 726,
|
|
|
- left: 726,
|
|
|
- right: 726,
|
|
|
- background: {
|
|
|
- r: rgb.r,
|
|
|
- g: rgb.g,
|
|
|
- b: rgb.b,
|
|
|
- alpha: 1
|
|
|
- }
|
|
|
- })
|
|
|
- .flatten({ background: { r: rgb.r, g: rgb.g, b: rgb.b, alpha: 1 } })
|
|
|
- } else if (options.splashscreen_type === 'overlay') {
|
|
|
- sharpSrc = sharp(splashSrc)
|
|
|
- .flatten({ background: { r: rgb.r, g: rgb.g, b: rgb.b, alpha: 1 } })
|
|
|
- .composite([
|
|
|
- {
|
|
|
- input: src
|
|
|
- // blend: 'multiply' <= future work, maybe just a gag
|
|
|
- }
|
|
|
- ])
|
|
|
- } else if (options.splashscreen_type === 'pure') {
|
|
|
- sharpSrc = sharp(splashSrc).flatten({
|
|
|
- background: { r: rgb.r, g: rgb.g, b: rgb.b, alpha: 1 }
|
|
|
- })
|
|
|
- } else {
|
|
|
- throw new Error(
|
|
|
- `unknown options.splashscreen_type: ${options.splashscreen_type}`
|
|
|
- )
|
|
|
- }
|
|
|
- const data = await sharpSrc.toBuffer()
|
|
|
-
|
|
|
- for (const optionKey in options) {
|
|
|
- const option = options[String(optionKey)]
|
|
|
- for (const sizeKey in option.sizes) {
|
|
|
- const size = option.sizes[String(sizeKey)]
|
|
|
- if (option.splash) {
|
|
|
- const dest = `${target}${path.sep}${option.folder}`
|
|
|
- await ensureDir(dest)
|
|
|
-
|
|
|
- if (option.infix === true) {
|
|
|
- output = `${dest}${path.sep}${option.prefix}${size}x${size}${option.suffix}`
|
|
|
- } else {
|
|
|
- output = `${dest}${path.sep}${option.prefix}${option.suffix}`
|
|
|
- }
|
|
|
- const pvar = [output, size]
|
|
|
- let sharpData = sharp(data)
|
|
|
- // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
|
- sharpData = sharpData.resize(pvar[1][0], pvar[1][1])
|
|
|
- // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
|
|
|
- await sharpData.toFile(pvar[0])
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
- },
|
|
|
-
|
|
|
- /**
|
|
|
- * Minifies a set of images
|
|
|
- *
|
|
|
- * @param {string} target - image location
|
|
|
- * @param {object} options - where to drop the images
|
|
|
- * @param {string} strategy - which minify strategy to use
|
|
|
- * @param {string} mode - singlefile or batch
|
|
|
- */
|
|
|
- minify: async function (
|
|
|
- target: string,
|
|
|
- // TODO: proper type for options
|
|
|
- options: { [index: string]: any },
|
|
|
- strategy: string,
|
|
|
- mode: string
|
|
|
- ) {
|
|
|
- let cmd: Plugin
|
|
|
- const minify = settings.options.minify
|
|
|
- if (!minify.available.find((x) => x === strategy)) {
|
|
|
- strategy = minify.type
|
|
|
- }
|
|
|
- switch (strategy) {
|
|
|
- case 'optipng':
|
|
|
- cmd = optipng(minify.optipngOptions)
|
|
|
- break
|
|
|
- case 'zopfli':
|
|
|
- cmd = zopfli(minify.zopfliOptions)
|
|
|
- break
|
|
|
- default:
|
|
|
- throw new Error('unknown strategy' + strategy)
|
|
|
- }
|
|
|
-
|
|
|
- const minifier = async (pvar: string[], cmd: Plugin): Promise<void> => {
|
|
|
- await imagemin([pvar[0]], {
|
|
|
- destination: pvar[1],
|
|
|
- plugins: [cmd]
|
|
|
- }).catch((err: string) => {
|
|
|
- warn(err)
|
|
|
- })
|
|
|
- }
|
|
|
-
|
|
|
- switch (mode) {
|
|
|
- case 'singlefile':
|
|
|
- await minifier([target, path.dirname(target)], cmd)
|
|
|
- break
|
|
|
- case 'batch':
|
|
|
- // eslint-disable-next-line no-case-declarations
|
|
|
- const folders = uniqueFolders(options)
|
|
|
- // eslint-disable-next-line @typescript-eslint/no-for-in-array
|
|
|
- for (const n in folders) {
|
|
|
- const folder = folders[Number(n)]
|
|
|
- log('batch minify:' + String(folder))
|
|
|
- await minifier(
|
|
|
- [
|
|
|
- `${target}${path.sep}${folder}${path.sep}*.png`,
|
|
|
- `${target}${path.sep}${folder}`
|
|
|
- ],
|
|
|
- cmd
|
|
|
- )
|
|
|
- }
|
|
|
- break
|
|
|
- default:
|
|
|
- warn('[ERROR] Minify mode must be one of [ singlefile | batch]')
|
|
|
- process.exit(1)
|
|
|
- }
|
|
|
- return 'minified'
|
|
|
- },
|
|
|
-
|
|
|
- /**
|
|
|
- * Creates special icns and ico filetypes
|
|
|
- *
|
|
|
- * @param {string} src - image location
|
|
|
- * @param {string} target - where to drop the images
|
|
|
- * @param {object} options
|
|
|
- * @param {string} strategy
|
|
|
- */
|
|
|
- icns: async function (
|
|
|
- src: string,
|
|
|
- target: string,
|
|
|
- // TODO: proper type for options
|
|
|
- options: { [index: string]: any },
|
|
|
- strategy: string
|
|
|
- ) {
|
|
|
- try {
|
|
|
- if (!image) {
|
|
|
- process.exit(1)
|
|
|
- }
|
|
|
- await this.validate(src, target)
|
|
|
-
|
|
|
- const s = sharp(src)
|
|
|
- const metadata = await s.metadata()
|
|
|
- const buf = await s.toBuffer()
|
|
|
- let icoBuf
|
|
|
- if (metadata.width !== metadata.height) {
|
|
|
- const size = Math.min(metadata.width ?? 256, metadata.height ?? 256)
|
|
|
- icoBuf = await s.resize(size, size).toBuffer()
|
|
|
- } else {
|
|
|
- icoBuf = await s.toBuffer()
|
|
|
- }
|
|
|
-
|
|
|
- const out = png2icons.createICNS(buf, png2icons.BICUBIC, 0)
|
|
|
- if (out === null) {
|
|
|
- throw new Error('Failed to create icon.icns')
|
|
|
- }
|
|
|
- ensureFileSync(path.join(target, '/icon.icns'))
|
|
|
- writeFileSync(path.join(target, '/icon.icns'), out)
|
|
|
-
|
|
|
- const out2 = await pngToIco(icoBuf)
|
|
|
- if (out2 === null) {
|
|
|
- throw new Error('Failed to create icon.ico')
|
|
|
- }
|
|
|
- ensureFileSync(path.join(target, '/icon.ico'))
|
|
|
- writeFileSync(path.join(target, '/icon.ico'), out2)
|
|
|
- } catch (err) {
|
|
|
- console.error(err)
|
|
|
- throw err
|
|
|
- }
|
|
|
- }
|
|
|
-}
|
|
|
-
|
|
|
-export default tauricon
|
nothingismagick