From c2dfd2fd3a9224bc61121f5abc2037050afaf563 Mon Sep 17 00:00:00 2001 From: Oliver-Akins Date: Mon, 3 Jan 2022 18:24:59 -0700 Subject: [PATCH] Convert from the symlink format to a local package --- common/enums/Status.ts | 7 --- common/package.json | 13 ++++ common/src/enums/Status.ts | 7 +++ common/src/index.ts | 4 ++ common/{ => src}/types/Colour.ts | 2 +- common/{ => src}/types/ServerResponse.ts | 2 +- common/{ => src}/types/events/SaveShip.ts | 8 ++- common/tsconfig.json | 73 +++++++++++++++++++++++ 8 files changed, 104 insertions(+), 12 deletions(-) delete mode 100644 common/enums/Status.ts create mode 100644 common/package.json create mode 100644 common/src/enums/Status.ts create mode 100644 common/src/index.ts rename common/{ => src}/types/Colour.ts (53%) rename common/{ => src}/types/ServerResponse.ts (82%) rename common/{ => src}/types/events/SaveShip.ts (65%) create mode 100644 common/tsconfig.json diff --git a/common/enums/Status.ts b/common/enums/Status.ts deleted file mode 100644 index 81df131..0000000 --- a/common/enums/Status.ts +++ /dev/null @@ -1,7 +0,0 @@ -export const Status = { - Success: 200, - UnknownError: 400, - OutOfDate: 401, - NotFound: 404, - Teapot: 418, -} \ No newline at end of file diff --git a/common/package.json b/common/package.json new file mode 100644 index 0000000..ea95da4 --- /dev/null +++ b/common/package.json @@ -0,0 +1,13 @@ +{ + "name": "common", + "version": "1.0.0", + "description": "", + "main": "dist/index.js", + "types": "dist/index.d.ts", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "Oliver Akins", + "license": "UNLICENSED", + "files": ["/dist"] +} diff --git a/common/src/enums/Status.ts b/common/src/enums/Status.ts new file mode 100644 index 0000000..a252cba --- /dev/null +++ b/common/src/enums/Status.ts @@ -0,0 +1,7 @@ +export enum Status { + Success = 200, + UnknownError = 400, + OutOfDate = 401, + NotFound = 404, + Teapot = 418, +} \ No newline at end of file diff --git a/common/src/index.ts b/common/src/index.ts new file mode 100644 index 0000000..74fa103 --- /dev/null +++ b/common/src/index.ts @@ -0,0 +1,4 @@ +export { Status } from "./enums/Status"; +export { Colour } from "./types/Colour"; +export * from "./types/events/SaveShip"; +export * from "./types/ServerResponse"; \ No newline at end of file diff --git a/common/types/Colour.ts b/common/src/types/Colour.ts similarity index 53% rename from common/types/Colour.ts rename to common/src/types/Colour.ts index 1820756..6aa2b9f 100644 --- a/common/types/Colour.ts +++ b/common/src/types/Colour.ts @@ -1,4 +1,4 @@ -interface Colour { +export interface Colour { name: string; hex: string; } \ No newline at end of file diff --git a/common/types/ServerResponse.ts b/common/src/types/ServerResponse.ts similarity index 82% rename from common/types/ServerResponse.ts rename to common/src/types/ServerResponse.ts index 235d2bd..90cdc63 100644 --- a/common/types/ServerResponse.ts +++ b/common/src/types/ServerResponse.ts @@ -1,4 +1,4 @@ -interface ServerResponse { +export interface ServerResponse { /** The state indicator for responses from the server */ status: number; diff --git a/common/types/events/SaveShip.ts b/common/src/types/events/SaveShip.ts similarity index 65% rename from common/types/events/SaveShip.ts rename to common/src/types/events/SaveShip.ts index 2841946..f514ddb 100644 --- a/common/types/events/SaveShip.ts +++ b/common/src/types/events/SaveShip.ts @@ -1,5 +1,7 @@ +import { ServerResponse } from "../ServerResponse"; + /** The data the client must provide in the `SaveShip` event. */ -interface SaveShip { +export interface SaveShip { colour: string; ship: string; } @@ -8,11 +10,11 @@ interface SaveShip { * The event that get's sent out to all the other players on a successful * `SaveShip` event */ -interface DesignUpdate { +export interface DesignUpdate { player: string; ship: string; colour: string; } /** The response to the client that triggered the `SaveShip` event. */ -interface SaveShipResponse extends ServerResponse {} \ No newline at end of file +export interface SaveShipResponse extends ServerResponse {} \ No newline at end of file diff --git a/common/tsconfig.json b/common/tsconfig.json new file mode 100644 index 0000000..8d9c2d6 --- /dev/null +++ b/common/tsconfig.json @@ -0,0 +1,73 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', 'ES2021', or 'ESNEXT'. */ + "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */ + "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + "outDir": "./dist", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + // "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an 'override' modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + + /* Advanced Options */ + "skipLibCheck": true, /* Skip type checking of declaration files. */ + "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ + }, + "include": [ "src/**/*" ] +}