fix(core): linting (#18)

* - add spine cache buster - add sprite sheet cache buster - tests * cache id is now takes into account all pipe options add test * docs * Update packages/spine/test/spineAtlasAll.test.ts * remove only * fix test and merge bits * rename * - update manifest plugin to remove specific logic - add a manifest modifier for texture packer - add a manifest modifier for spine atlas * fix options * fix options * fin name * fix tests * fix:(core): linting * merge --------- Co-authored-by: Mat Groves <[email protected]>
play-co · Apr 29, 2024 · c74d163 · c74d163
1 parent ef71c06
commit c74d163
Show file tree

Hide file tree

Showing 75 changed files with 193 additions and 162 deletions.
diff --git a/package.json b/package.json
@@ -10,6 +10,7 @@
     "build:force": "nx run-many --target=build --all --parallel --skip-nx-cache",
     "clean": "rimraf packages/*/{dist,.testInput,.testOutput,.assetpack}",
     "lint": "eslint --cache packages shared --ext .js,.ts,.mjs --max-warnings 0",
+    "lint:fix": "npm run lint -- --fix",
     "prepare": "husky install",
     "prerelease": "npm run lint && npm run build:force",
     "release": "lerna publish --no-private --exact --force-publish",

diff --git a/packages/cache-buster/rollup.config.mjs b/packages/cache-buster/rollup.config.mjs
@@ -1,5 +1,4 @@
 import { readFileSync } from 'fs';
-
 import { createConfig } from '../../shared/rollup.config.mjs';
 
 export default createConfig({

diff --git a/packages/cache-buster/src/cacheBuster.ts b/packages/cache-buster/src/cacheBuster.ts
@@ -1,6 +1,7 @@
-import type { AssetPipe, Asset } from '@play-co/assetpack-core';
 import { createNewAssetAt, swapExt } from '@play-co/assetpack-core';
 
+import type { Asset, AssetPipe } from '@play-co/assetpack-core';
+
 /**
  * Cache buster asset pipe. This pipe will add a hash to the end of the filename
  * the hash is calculated from the contents of the file.

diff --git a/packages/cache-buster/test/cacheBuster.test.ts b/packages/cache-buster/test/cacheBuster.test.ts
@@ -1,7 +1,7 @@
-import { Asset, AssetPack, path } from '@play-co/assetpack-core';
 import { existsSync } from 'fs-extra';
 import { assetPath, createFolder, getInputDir, getOutputDir } from '../../../shared/test';
 import { cacheBuster } from '../src';
+import { Asset, AssetPack, path } from '@play-co/assetpack-core';
 
 const pkg = 'cache-buster';
 

diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -1,11 +1,12 @@
 /* eslint-disable no-console */
-import type { AssetPackConfig } from '@play-co/assetpack-core';
 import chalk from 'chalk';
 import { Command } from 'commander';
 import findUp from 'find-up';
+import { createRequire } from 'module';
 import path from 'path';
 import { pathToFileURL } from 'url';
-import { createRequire } from 'module';
+
+import type { AssetPackConfig } from '@play-co/assetpack-core';
 
 const require = createRequire(import.meta.url);
 

diff --git a/packages/core/rollup.config.mjs b/packages/core/rollup.config.mjs
@@ -1,5 +1,4 @@
 import { readFileSync } from 'fs';
-
 import { createConfig } from '../../shared/rollup.config.mjs';
 
 export default createConfig({

diff --git a/packages/core/src/Asset.ts b/packages/core/src/Asset.ts
@@ -1,7 +1,7 @@
-import { extractTagsFromFileName } from './utils/extractTagsFromFileName';
-import { getHash } from './utils/getHash';
 import fs from 'fs-extra';
 import { Logger } from './logger/Logger';
+import { extractTagsFromFileName } from './utils/extractTagsFromFileName';
+import { getHash } from './utils/getHash';
 import { path } from './utils/path';
 
 export interface AssetOptions

diff --git a/packages/core/src/AssetCache.ts b/packages/core/src/AssetCache.ts
@@ -1,7 +1,8 @@
-import type { Asset } from './Asset';
 import fs from 'fs-extra';
 import { path } from './utils/path';
 
+import type { Asset } from './Asset';
+
 export interface AssetCacheOptions
 {
     cacheName?: string;

diff --git a/packages/core/src/AssetPack.ts b/packages/core/src/AssetPack.ts
@@ -1,17 +1,18 @@
 import fs from 'fs-extra';
-import type { Asset } from './Asset';
-import type { AssetPipe } from './pipes/AssetPipe';
+import merge from 'merge';
 import { AssetCache } from './AssetCache';
 import { AssetWatcher } from './AssetWatcher';
-import type { AssetSettings } from './pipes/PipeSystem';
-import { PipeSystem } from './pipes/PipeSystem';
-import { finalCopyPipe } from './pipes/finalCopyPipe';
-import type { AssetPackConfig } from './config';
 import { Logger } from './logger/Logger';
-import { promiseAllConcurrent } from './utils/promiseAllConcurrent';
-import { path } from './utils/path';
-import merge from 'merge';
+import { finalCopyPipe } from './pipes/finalCopyPipe';
+import { PipeSystem } from './pipes/PipeSystem';
 import { generateCacheName } from './utils/generateCacheName';
+import { path } from './utils/path';
+import { promiseAllConcurrent } from './utils/promiseAllConcurrent';
+
+import type { Asset } from './Asset';
+import type { AssetPackConfig } from './config';
+import type { AssetPipe } from './pipes/AssetPipe';
+import type { AssetSettings } from './pipes/PipeSystem';
 
 export class AssetPack
 {

diff --git a/packages/core/src/AssetWatcher.ts b/packages/core/src/AssetWatcher.ts
@@ -1,13 +1,14 @@
+import chokidar from 'chokidar';
 import fs from 'fs-extra';
 import { Asset } from './Asset';
-import chokidar from 'chokidar';
-import type { CachedAsset } from './AssetCache';
-import { syncAssetsWithCache } from './utils/syncAssetsWithCache';
 import { AssetIgnore } from './AssetIgnore';
-import type { AssetSettings } from './pipes/PipeSystem';
+import { Logger } from './logger/Logger';
 import { applySettingToAsset } from './utils/applySettingToAsset';
 import { path } from './utils/path';
-import { Logger } from './logger/Logger';
+import { syncAssetsWithCache } from './utils/syncAssetsWithCache';
+
+import type { CachedAsset } from './AssetCache';
+import type { AssetSettings } from './pipes/PipeSystem';
 
 export interface AssetWatcherOptions
 {

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -1,19 +1,15 @@
-// export * from './AssetPack';
-export * from './config';
-export * from './logger/Logger';
-// export * from './Plugin';
-// export * from './Processor';
-// export * from './utils';
 export * from './Asset';
 export * from './AssetPack';
 export * from './config';
+export * from './config';
+export * from './logger/Logger';
 export * from './pipes/AssetPipe';
-export * from './pipes/PipeSystem';
 export * from './pipes/multiPipe';
+export * from './pipes/PipeSystem';
 export * from './utils/checkExt';
 export * from './utils/createNewAssetAt';
+export * from './utils/findAssets';
 export * from './utils/merge';
 export * from './utils/path';
 export * from './utils/stripTags';
 export * from './utils/swapExt';
-export * from './utils/findAssets';
diff --git a/packages/core/src/logger/Logger.ts b/packages/core/src/logger/Logger.ts
@@ -1,6 +1,7 @@
-import type { ReporterEvent } from './Reporter';
 import { Reporter } from './Reporter';
+
 import type { LogLevelKeys } from './logLevel';
+import type { ReporterEvent } from './Reporter';
 
 export interface LoggerOptions
 {

diff --git a/packages/core/src/logger/Reporter.ts b/packages/core/src/logger/Reporter.ts
@@ -1,9 +1,10 @@
 import chalk from 'chalk';
-import type { LogLevelKeys } from './logLevel';
 import { LogLevel } from './logLevel';
 import { persistMessage, resetWindow, startProgress, stopProgress, updateProgress } from './render';
 import { prettifyTime } from './utils';
 
+import type { LogLevelKeys } from './logLevel';
+
 export interface LogEvent
 {
     type: 'log';

diff --git a/packages/core/src/logger/render.ts b/packages/core/src/logger/render.ts
@@ -1,9 +1,9 @@
-import type { Writable } from 'stream';
+import chalk from 'chalk';
 import cliProgress from 'cli-progress';
-
 import readline from 'readline';
 import { countLines } from './utils';
-import chalk from 'chalk';
+
+import type { Writable } from 'stream';
 
 const stdout = process.stdout;
 const stderr = process.stderr;

diff --git a/packages/core/src/pipes/PipeSystem.ts b/packages/core/src/pipes/PipeSystem.ts
@@ -1,8 +1,9 @@
-import type { Asset } from '../Asset';
-import type { AssetPipe } from './AssetPipe';
 import { mergePipeOptions } from './mergePipeOptions';
 import { multiPipe } from './multiPipe';
 
+import type { Asset } from '../Asset';
+import type { AssetPipe } from './AssetPipe';
+
 export interface PipeSystemOptions
 {
     pipes: (AssetPipe | AssetPipe[])[];

diff --git a/packages/core/src/pipes/finalCopyPipe.ts b/packages/core/src/pipes/finalCopyPipe.ts
@@ -1,6 +1,7 @@
 import fs from 'fs-extra';
-import type { Asset } from '../Asset';
 import { createNewAssetAt } from '../utils/createNewAssetAt';
+
+import type { Asset } from '../Asset';
 import type { AssetPipe } from './AssetPipe';
 
 export const finalCopyPipe: AssetPipe<object> = {

diff --git a/packages/core/src/pipes/multiPipe.ts b/packages/core/src/pipes/multiPipe.ts
@@ -1,7 +1,8 @@
+import { mergePipeOptions } from './mergePipeOptions';
+
 import type { Asset } from '../Asset';
 import type { AssetPipe } from './AssetPipe';
 import type { PipeSystem } from './PipeSystem';
-import { mergePipeOptions } from './mergePipeOptions';
 
 export interface MultiPipeOptions
 {

diff --git a/packages/core/src/utils/applySettingToAsset.ts b/packages/core/src/utils/applySettingToAsset.ts
@@ -1,9 +1,10 @@
-import type { Asset } from '../Asset';
-import type { AssetSettings } from '../pipes/PipeSystem';
 import minimatch from 'minimatch';
 import { merge } from './merge';
 import { path } from './path';
 
+import type { Asset } from '../Asset';
+import type { AssetSettings } from '../pipes/PipeSystem';
+
 export function applySettingToAsset(asset: Asset, settings: AssetSettings[], entryPath: string)
 {
     const relativePath = path.relative(entryPath, asset.path);

diff --git a/packages/core/src/utils/generateCacheName.ts b/packages/core/src/utils/generateCacheName.ts
@@ -1,6 +1,7 @@
-import type { AssetPackConfig } from '../config';
 import objectHash from 'object-hash';
 
+import type { AssetPackConfig } from '../config';
+
 /**
  * Returns a unique name based on the hash generated from the config
  * this takes into account the following:

diff --git a/packages/core/src/utils/logAssetGraph.ts b/packages/core/src/utils/logAssetGraph.ts
@@ -1,6 +1,7 @@
-import type { Asset } from '../Asset';
 import { path } from './path';
 
+import type { Asset } from '../Asset';
+
 const stateColorMap = {
     normal: 'white',
     added: 'green',

diff --git a/packages/core/src/utils/path.ts b/packages/core/src/utils/path.ts
@@ -1,2 +1,3 @@
 import upath from 'upath';
+
 export const path = upath;
diff --git a/packages/core/src/utils/syncAssetsWithCache.ts b/packages/core/src/utils/syncAssetsWithCache.ts
@@ -1,4 +1,5 @@
 import { Asset } from '../Asset';
+
 import type { CachedAsset } from '../AssetCache';
 
 export function syncAssetsWithCache(assetHash: Record<string, Asset>, cachedData: Record<string, CachedAsset>)

diff --git a/packages/core/test/AssetWatcher.test.ts b/packages/core/test/AssetWatcher.test.ts
@@ -1,7 +1,7 @@
 import { assetPath, createFolder, getInputDir } from '../../../shared/test';
 import { Asset } from '../src/Asset';
-import { AssetWatcher } from '../src/AssetWatcher';
 import { AssetCache } from '../src/AssetCache';
+import { AssetWatcher } from '../src/AssetWatcher';
 import { logAssetGraph } from '../src/utils/logAssetGraph';
 
 const pkg = 'core';

diff --git a/packages/core/test/Assetpack.test.ts b/packages/core/test/Assetpack.test.ts
@@ -1,9 +1,10 @@
 import { existsSync, removeSync, writeJSONSync } from 'fs-extra';
 import { join } from 'path';
-import type { MockAssetPipe } from '../../../shared/test/index';
-import { assetPath, createFolder, createAssetPipe, getInputDir, getOutputDir } from '../../../shared/test/index';
+import { assetPath, createAssetPipe, createFolder, getInputDir, getOutputDir } from '../../../shared/test/index';
 import { AssetPack } from '../src/AssetPack';
 import { logAssetGraph } from '../src/utils/logAssetGraph';
+
+import type { MockAssetPipe } from '../../../shared/test/index';
 import type { AssetPipe } from '../src/pipes/AssetPipe';
 
 const pkg = 'core';

diff --git a/packages/core/test/PipeSystem.test.ts b/packages/core/test/PipeSystem.test.ts
@@ -1,7 +1,8 @@
 import { Asset } from '../src/Asset';
-import type { AssetPipe } from '../src/pipes/AssetPipe';
 import { PipeSystem } from '../src/pipes/PipeSystem';
 
+import type { AssetPipe } from '../src/pipes/AssetPipe';
+
 describe('PipeSystem', () =>
 {
     it('should transform an asset', async () =>

diff --git a/packages/core/test/Utils.test.ts b/packages/core/test/Utils.test.ts
@@ -1,10 +1,11 @@
-import type { MockAssetPipe } from '../../../shared/test/index';
-import { createFolder, createAssetPipe, getInputDir, getOutputDir } from '../../../shared/test/index';
-import type { Asset } from '../src/Asset';
+import { createAssetPipe, createFolder, getInputDir, getOutputDir } from '../../../shared/test/index';
 import { AssetPack } from '../src/AssetPack';
 import { extractTagsFromFileName } from '../src/utils/extractTagsFromFileName';
 import { generateCacheName } from '../src/utils/generateCacheName';
 
+import type { MockAssetPipe } from '../../../shared/test/index';
+import type { Asset } from '../src/Asset';
+
 describe('Utils', () =>
 {
     const pkg = 'core';

diff --git a/packages/core/test/config.test.ts b/packages/core/test/config.test.ts
@@ -1,5 +1,6 @@
 import { createAssetPipe } from '../../../shared/test';
 import { AssetPack } from '../src';
+
 import type { AssetPackConfig } from '../src/config';
 
 describe('AssetPack Config', () =>

diff --git a/packages/ffmpeg/rollup.config.mjs b/packages/ffmpeg/rollup.config.mjs
@@ -1,5 +1,4 @@
 import { readFileSync } from 'fs';
-
 import { createConfig } from '../../shared/rollup.config.mjs';
 
 export default createConfig({

diff --git a/packages/ffmpeg/src/audio.ts b/packages/ffmpeg/src/audio.ts
@@ -1,7 +1,8 @@
+import { ffmpeg } from './ffmpeg';
 import { merge } from '@play-co/assetpack-core';
-import type { AssetPipe } from '@play-co/assetpack-core';
+
 import type { FfmpegOptions } from './ffmpeg';
-import { ffmpeg } from './ffmpeg';
+import type { AssetPipe } from '@play-co/assetpack-core';
 
 export function audio(_options?: FfmpegOptions): AssetPipe
 {

diff --git a/packages/ffmpeg/src/ffmpeg.ts b/packages/ffmpeg/src/ffmpeg.ts
@@ -1,8 +1,9 @@
-import type { AssetPipe, Asset } from '@play-co/assetpack-core';
-import { checkExt, createNewAssetAt, path } from '@play-co/assetpack-core';
 import fluentFfmpeg from 'fluent-ffmpeg';
-import ffmpegPath from '@ffmpeg-installer/ffmpeg';
 import fs from 'fs-extra';
+import ffmpegPath from '@ffmpeg-installer/ffmpeg';
+import { checkExt, createNewAssetAt, path } from '@play-co/assetpack-core';
+
+import type { Asset, AssetPipe } from '@play-co/assetpack-core';
 
 fluentFfmpeg.setFfmpegPath(ffmpegPath.path);
 

diff --git a/packages/ffmpeg/src/index.ts b/packages/ffmpeg/src/index.ts
@@ -1,2 +1,2 @@
-export * from './ffmpeg';
 export * from './audio';
+export * from './ffmpeg';
diff --git a/packages/ffmpeg/test/Audio.test.ts b/packages/ffmpeg/test/Audio.test.ts
@@ -1,7 +1,7 @@
-import { AssetPack } from '@play-co/assetpack-core';
-import { audio } from '@play-co/assetpack-plugin-ffmpeg';
 import { existsSync } from 'fs-extra';
 import { assetPath, createFolder, getInputDir, getOutputDir } from '../../../shared/test';
+import { AssetPack } from '@play-co/assetpack-core';
+import { audio } from '@play-co/assetpack-plugin-ffmpeg';
 
 const pkg = 'ffmpeg';
 

diff --git a/packages/image/rollup.config.mjs b/packages/image/rollup.config.mjs
@@ -1,5 +1,4 @@
 import { readFileSync } from 'fs';
-
 import { createConfig } from '../../shared/rollup.config.mjs';
 
 export default createConfig({

diff --git a/packages/image/src/compress.ts b/packages/image/src/compress.ts
@@ -1,9 +1,10 @@
-import type { PluginOptions, Asset, AssetPipe } from '@play-co/assetpack-core';
-import { checkExt, createNewAssetAt  } from '@play-co/assetpack-core';
-import type { AvifOptions, JpegOptions, PngOptions, WebpOptions } from 'sharp';
 import sharp from 'sharp';
-import { resolveOptions } from './utils/resolveOptions';
 import { compressSharp } from './utils/compressSharp';
+import { resolveOptions } from './utils/resolveOptions';
+import { checkExt, createNewAssetAt } from '@play-co/assetpack-core';
+
+import type { AvifOptions, JpegOptions, PngOptions, WebpOptions } from 'sharp';
+import type { Asset, AssetPipe, PluginOptions } from '@play-co/assetpack-core';
 
 type CompressJpgOptions = Omit<JpegOptions, 'force'>;
 type CompressWebpOptions = Omit<WebpOptions, 'force'>;

diff --git a/packages/image/src/mipmap.ts b/packages/image/src/mipmap.ts
@@ -1,9 +1,10 @@
-import type { Asset, AssetPipe, PluginOptions } from '@play-co/assetpack-core';
-import { checkExt, createNewAssetAt } from '@play-co/assetpack-core';
 import sharp from 'sharp';
-import type { CompressImageData } from './compress';
 import { mipmapSharp } from './utils/mipmapSharp';
 import { resolveOptions } from './utils/resolveOptions';
+import { checkExt, createNewAssetAt } from '@play-co/assetpack-core';
+
+import type { CompressImageData } from './compress';
+import type { Asset, AssetPipe, PluginOptions } from '@play-co/assetpack-core';
 
 export interface MipmapOptions<T extends string = ''> extends PluginOptions<'fix' | T>
 {
@@ -46,7 +47,7 @@ export function mipmap(_options: MipmapOptions = {}): AssetPipe<MipmapOptions>
         },
         async transform(asset: Asset, options)
         {
-            const shouldMipmap =  mipmap && !asset.metaData[options.tags.fix as any];
+            const shouldMipmap = mipmap && !asset.metaData[options.tags.fix as any];
 
             let processedImages: CompressImageData[];
 

diff --git a/packages/image/src/utils/compressSharp.ts b/packages/image/src/utils/compressSharp.ts
@@ -1,4 +1,4 @@
-import type { AvifOptions, WebpOptions, JpegOptions, PngOptions } from 'sharp';
+import type { AvifOptions, JpegOptions, PngOptions, WebpOptions } from 'sharp';
 import type { CompressImageData, CompressOptions } from '../compress';
 
 export async function compressSharp(
Original file line number	Diff line number	Diff line change
		@@ -1,2 +1,3 @@
		import upath from 'upath';

		export const path = upath;