Clear out @upscalerjs/core directory and its references (#1189)

* Clear out @upscalerjs/core directory and its references
thekevinscott · Oct 9, 2023 · e74eb91 · e74eb91
1 parent c13cb03
commit e74eb91
Show file tree

Hide file tree

Showing 30 changed files with 20 additions and 640 deletions.
diff --git a/.deepsource.toml b/.deepsource.toml
@@ -3,8 +3,6 @@ version = 1
 test_patterns = ["packages/upscalerjs/src/**/*.ts"]
 
 exclude_patterns = [
-  "packages/core/src/**/*.test.ts", 
-  "packages/core/jest.setup.ts", 
   "packages/upscalerjs/src/**/*.test.ts", 
   "packages/upscalerjs/jest.setup.ts", 
   "examples/**", 

diff --git a/internals/common/src/constants.ts b/internals/common/src/constants.ts
@@ -16,7 +16,6 @@ export const DEV_DIR = path.resolve(ROOT_DIR, 'dev');
 export const PACKAGES_DIR = path.resolve(ROOT_DIR, 'packages');
 
 export const UPSCALER_DIR = path.resolve(PACKAGES_DIR, 'upscalerjs');
-export const CORE_DIR = path.resolve(PACKAGES_DIR, 'core');
 export const SHARED_DIR = path.resolve(PACKAGES_DIR, 'shared');
 export const WRAPPER_DIR = path.resolve(PACKAGES_DIR, 'upscalerjs-wrapper');
 

diff --git a/internals/upscaler-cli/src/lib/package-scripts/docs/build-api.ts b/internals/upscaler-cli/src/lib/package-scripts/docs/build-api.ts
@@ -11,7 +11,7 @@ import {
   ReflectionKind,
 } from 'typedoc';
 import { Platform } from '../prompt/types';
-import { CORE_DIR, DOCS_DIR, UPSCALER_DIR } from '../utils/constants';
+import { DOCS_DIR, UPSCALER_DIR } from '../utils/constants';
 import { clearOutMarkdownFiles } from './utils/clear-out-markdown-files';
 import { getSharedArgs, SharedArgs } from './types';
 import {
@@ -299,8 +299,6 @@ const writePlatformSpecificDefinitions = (definitions: Definitions): string => {
  */
 const UPSCALER_TSCONFIG_PATH = path.resolve(UPSCALER_DIR, 'tsconfig.browser.esm.json');
 const UPSCALER_SRC_PATH = path.resolve(UPSCALER_DIR, 'src/browser/esm');
-const CORE_TSCONFIG_PATH = path.resolve(CORE_DIR, 'tsconfig.json');
-const CORE_SRC_PATH = path.resolve(CORE_DIR, 'src');
 const EXAMPLES_DOCS_DEST = path.resolve(DOCS_DIR, 'docs/documentation/api');
 const VALID_EXPORTS_FOR_WRITING_DOCS = ['default'];
 const VALID_METHODS_FOR_WRITING_DOCS = [
@@ -459,18 +457,12 @@ const getDefinitions = async (): Promise<Definitions> => {
     UPSCALER_DIR,
   );
   console.log('***** 2')
-  const coreTree = getPackageAsTree(
-    CORE_SRC_PATH, 
-    CORE_TSCONFIG_PATH,
-    CORE_DIR,
-  );
   const platformSpecificTypes = await getTypesFromPlatformSpecificFiles();
   if (!upscalerTree.children) {
     throw new Error('No children were found on upscaler tree object. Indicates an error in the returned structure from getPackageAsTree');
   }
   const children = [
     ...upscalerTree.children,
-    ...(coreTree.children || []),
     ...(platformSpecificTypes.children || []),
   ];
 

diff --git a/internals/upscaler-cli/src/lib/package-scripts/update-version.ts b/internals/upscaler-cli/src/lib/package-scripts/update-version.ts
@@ -1,6 +1,6 @@
 import inquirer from 'inquirer';
 import isValidVersion from './utils/isValidVersion';
-import { AVAILABLE_PACKAGES, CORE, DIRECTORIES, EXAMPLES, getPackageJSON, getPackageJSONPath, getPreparedFolderName, Package, PackageUpdaterLogger, ROOT, TransformPackageJsonFn, updateMultiplePackages, updateSinglePackage, UPSCALER_JS, WRAPPER } from './utils/packages';
+import { AVAILABLE_PACKAGES, DIRECTORIES, EXAMPLES, getPackageJSON, getPackageJSONPath, getPreparedFolderName, Package, PackageUpdaterLogger, ROOT, TransformPackageJsonFn, updateMultiplePackages, updateSinglePackage, UPSCALER_JS, WRAPPER } from './utils/packages';
 import { ROOT_DIR } from './utils/constants';
 
 /****
@@ -27,11 +27,9 @@ const getVersion = (dir: string) => {
 const getCurrentVersions = () => {
   const upscalerJSVersion = getVersion(DIRECTORIES[UPSCALER_JS].directory);
   const rootVersion = getVersion(DIRECTORIES[ROOT].directory);
-  const coreVersion = getVersion(DIRECTORIES[CORE].directory);
   return [
     `root: ${rootVersion}`,
     `upscaler: ${upscalerJSVersion}`,
-    `core: ${coreVersion}`,
   ].join(' | ');
 };
 

diff --git a/internals/upscaler-cli/src/lib/package-scripts/utils/constants.ts b/internals/upscaler-cli/src/lib/package-scripts/utils/constants.ts
@@ -17,6 +17,5 @@ export const DEV_DIR = path.resolve(ROOT_DIR, 'dev');
 export const PACKAGES_DIR = path.resolve(ROOT_DIR, 'packages');
 
 export const UPSCALER_DIR = path.resolve(PACKAGES_DIR, 'upscalerjs');
-export const CORE_DIR = path.resolve(PACKAGES_DIR, 'core');
 export const SHARED_DIR = path.resolve(PACKAGES_DIR, 'shared');
 export const WRAPPER_DIR = path.resolve(PACKAGES_DIR, 'upscalerjs-wrapper');
diff --git a/internals/upscaler-cli/src/lib/package-scripts/utils/packages.ts b/internals/upscaler-cli/src/lib/package-scripts/utils/packages.ts
@@ -2,7 +2,7 @@ import fs from 'fs';
 import path from 'path';
 import findAllPackages from '../find-all-packages.js';
 import { JSONSchemaForNPMPackageJsonFiles } from '@schemastore/package';
-import { CORE_DIR, DEV_DIR, DOCS_DIR, EXAMPLES_DIR, MODELS_DIR, PACKAGES_DIR, ROOT_DIR, TEST_DIR, UPSCALER_DIR, WRAPPER_DIR } from './constants.js';
+import { DEV_DIR, DOCS_DIR, EXAMPLES_DIR, MODELS_DIR, PACKAGES_DIR, ROOT_DIR, TEST_DIR, UPSCALER_DIR, WRAPPER_DIR } from './constants.js';
 
 interface FakeExports {
   [index: string]: string | FakeExports;
@@ -12,12 +12,11 @@ export type JSONSchema = JSONSchemaForNPMPackageJsonFiles & {
   exports: FakeExports;
 };
 
-export type Package = 'UpscalerJS' | 'Core' | 'Models' | 'Test' | 'Examples' | 'Root' | 'Wrapper' | 'Dev' | 'Packages';
+export type Package = 'UpscalerJS' | 'Models' | 'Test' | 'Examples' | 'Root' | 'Wrapper' | 'Dev' | 'Packages';
 export type TransformPackageJsonFn = (packageJSON: JSONSchema, dir: string) => JSONSchema;
 export type PackageUpdaterLogger = (file: string) => (string | undefined);
 
 export const UPSCALER_JS = 'UpscalerJS';
-export const CORE = 'Core';
 export const ROOT = 'Root';
 export const WRAPPER = 'Wrapper';
 export const EXAMPLES = 'Examples';
@@ -27,12 +26,11 @@ export const DEV = 'Development';
 export const DOCS = 'Docs';
 export const PACKAGES = 'Packages';
 
-export const AVAILABLE_PACKAGES = [ ROOT, UPSCALER_JS, CORE, MODELS, EXAMPLES, TEST, WRAPPER, DEV, DOCS, PACKAGES ];
+export const AVAILABLE_PACKAGES = [ ROOT, UPSCALER_JS, MODELS, EXAMPLES, TEST, WRAPPER, DEV, DOCS, PACKAGES ];
 
 export const DIRECTORIES: Record<string, { directory: string, multiple?: boolean }> = {
   [ROOT]: { directory: ROOT_DIR },
   [UPSCALER_JS]: { directory: UPSCALER_DIR },
-  [CORE]: { directory: CORE_DIR },
   [MODELS]: { directory: MODELS_DIR, multiple: true },
   [EXAMPLES]: { directory: EXAMPLES_DIR, multiple: true },
   [TEST]: { directory: TEST_DIR, multiple: true },

diff --git a/models/default-model/package.json b/models/default-model/package.json
@@ -83,7 +83,6 @@
     "build": {
       "command": "pnpm build:cjs && pnpm build:esm && pnpm build:umd",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [

diff --git a/models/esrgan-legacy/package.json b/models/esrgan-legacy/package.json
@@ -131,7 +131,6 @@
     "build:cjs": {
       "command": "tsc -p ./tsconfig.cjs.json --outDir ./dist/cjs --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -152,7 +151,6 @@
     "build:esm": {
       "command": "tsc -p ./tsconfig.esm.json --outDir ./dist/esm --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -173,7 +171,6 @@
     "build:umd": {
       "command": "pnpm run build:umd:tsc && pnpm run build:umd:index && pnpm run build:umd:div2k/x2 && pnpm run build:umd:div2k/x3 && pnpm run build:umd:div2k/x4 && pnpm run build:umd:psnr-small && pnpm run build:umd:gans && rimraf ./dist/umd-tmp",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [

diff --git a/models/esrgan-medium/package.json b/models/esrgan-medium/package.json
@@ -135,7 +135,6 @@
     "build:cjs": {
       "command": "tsc -p ./tsconfig.cjs.json --outDir ./dist/cjs --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -156,7 +155,6 @@
     "build:esm": {
       "command": "tsc -p ./tsconfig.esm.json --outDir ./dist/esm --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -177,7 +175,6 @@
     "build:umd": {
       "command": "pnpm run build:umd:tsc && pnpm run build:umd:index && pnpm run build:umd:x2 && pnpm run build:umd:x3 && pnpm run build:umd:x4 && pnpm run build:umd:x8 && rimraf ./dist/umd-tmp",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [

diff --git a/models/esrgan-slim/package.json b/models/esrgan-slim/package.json
@@ -135,7 +135,6 @@
     "build:cjs": {
       "command": "tsc -p ./tsconfig.cjs.json --outDir ./dist/cjs --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -156,7 +155,6 @@
     "build:esm": {
       "command": "tsc -p ./tsconfig.esm.json --outDir ./dist/esm --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -177,7 +175,6 @@
     "build:umd": {
       "command": "pnpm run build:umd:tsc && pnpm run build:umd:index && pnpm run build:umd:x2 && pnpm run build:umd:x3 && pnpm run build:umd:x4 && pnpm run build:umd:x8 && rimraf ./dist/umd-tmp",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [

diff --git a/models/esrgan-thick/package.json b/models/esrgan-thick/package.json
@@ -128,7 +128,6 @@
     "build:cjs": {
       "command": "tsc -p ./tsconfig.cjs.json --outDir ./dist/cjs --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -149,7 +148,6 @@
     "build:esm": {
       "command": "tsc -p ./tsconfig.esm.json --outDir ./dist/esm --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -170,7 +168,6 @@
     "build:umd": {
       "command": "pnpm run build:umd:tsc && pnpm run build:umd:index && pnpm run build:umd:x2 && pnpm run build:umd:x3 && pnpm run build:umd:x4 && pnpm run build:umd:x8 && rimraf ./dist/umd-tmp",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [

diff --git a/models/pixel-upsampler/package.json b/models/pixel-upsampler/package.json
@@ -106,7 +106,6 @@
     "build:cjs": {
       "command": "tsc -p ./tsconfig.cjs.json --outDir ./dist/cjs --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -126,7 +125,6 @@
     "build:esm": {
       "command": "tsc -p ./tsconfig.esm.json --outDir ./dist/esm --baseUrl ./src",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [
@@ -146,7 +144,6 @@
     "build:umd": {
       "command": "pnpm run build:umd:tsc && pnpm run build:umd:index && pnpm run build:umd:x2 && pnpm run build:umd:x3 && pnpm run build:umd:x4 && rimraf ./dist/umd-tmp",
       "dependencies": [
-        "../../packages/core:build",
         "scaffold"
       ],
       "files": [

diff --git a/package.json b/package.json
@@ -198,7 +198,6 @@
     },
     "postinstall": {
       "dependencies": [
-        "./packages/core:build",
         "./models/default-model:build"
       ]
     },

diff --git a/packages/core/.eslintrc.js b/packages/core/.eslintrc.js
diff --git a/packages/core/.npmignore b/packages/core/.npmignore
diff --git a/packages/core/README.md b/packages/core/README.md
@@ -1,3 +1,3 @@
-This package is a folder of shared types and functions consumed by UpscalerJS and its upscaling models. You shouldn't install this package directly.
+**DEPRECATED**
 
-For more information on UpscalerJS, [check out the documentation](https://upscalerjs.com).
+This package is deprecated. Please install `upscaler` and import types from its exports.