From dd74e19009ab57fa5636b36d7021bd85bf61371d Mon Sep 17 00:00:00 2001 From: Francesco Saverio Cannizzaro Date: Tue, 26 Dec 2023 22:02:35 +0100 Subject: [PATCH] convert to typescript --- .github/workflows/publish-package.yaml | 1 + .npmignore | 2 + index.d.ts | 15 ---- index.js => index.ts | 46 ++++++----- package-lock.json | 40 +++++++-- package.json | 19 +++-- tsconfig.json | 109 +++++++++++++++++++++++++ 7 files changed, 186 insertions(+), 46 deletions(-) delete mode 100644 index.d.ts rename index.js => index.ts (59%) create mode 100644 tsconfig.json diff --git a/.github/workflows/publish-package.yaml b/.github/workflows/publish-package.yaml index 6816a99..b0e9dd3 100644 --- a/.github/workflows/publish-package.yaml +++ b/.github/workflows/publish-package.yaml @@ -16,6 +16,7 @@ jobs: registry-url: "https://registry.npmjs.org" - run: npm install -g npm - run: npm ci + - run: npm run build - run: npm publish --provenance --access public env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.npmignore b/.npmignore index 26f5c15..7cc6cc2 100644 --- a/.npmignore +++ b/.npmignore @@ -1 +1,3 @@ .github +index.ts +tsconfig.json diff --git a/index.d.ts b/index.d.ts deleted file mode 100644 index e995765..0000000 --- a/index.d.ts +++ /dev/null @@ -1,15 +0,0 @@ -import type { Plugin } from "rollup"; - -export interface RollupElgatoDistributionToolPluginOptions { - /** - * Path of the .sdPlugin directory - */ - plugin: string; - - /** - * Path where put the .streamdeckPlugin package - */ - output?: string; -} - -export default function (options: RollupElgatoDistributionToolPluginOptions): Plugin; diff --git a/index.js b/index.ts similarity index 59% rename from index.js rename to index.ts index 0fe657b..15ebf95 100644 --- a/index.js +++ b/index.ts @@ -1,17 +1,33 @@ import { execSync } from "child_process"; +import type { Plugin } from "rollup"; +import path from "path"; import os from "os"; import fs from "fs"; -import path from "path"; import url from "url"; const __dirname = url.fileURLToPath(new URL(".", import.meta.url)); +interface PluginOptions { + /** + * Path of the .sdPlugin directory + */ + plugin: string; + + /** + * Path where put the .streamdeckPlugin package + */ + output?: string; +} + +const Binaries: Record = { + win32: "DistributionTool.exe", + darwin: "DistributionTool", +}; + /** - * - * @param {import(".").RollupElgatoDistributionToolPluginOptions} options - * @returns {import("rollup").Plugin} + * Rollup plugin to package a .sdPlugin directory into a .streamdeckPlugin package using the Elgato Distribution Tool */ -export default function (options) { +export default function (options: PluginOptions): Plugin { if (!options.plugin) { throw new Error("Missing plugin param"); } @@ -19,13 +35,7 @@ export default function (options) { name: "stream-deck-package", closeBundle() { const platform = os.platform(); - - const bin = - platform === "win32" - ? "DistributionTool.exe" - : platform === "darwin" - ? "DistributionTool" - : undefined; + const bin = Binaries[platform]; if (!bin) { return this.error(`Unsupported platform ${platform}`); @@ -54,15 +64,13 @@ export default function (options) { fs.rmSync(filePath); } - try { - platform === "darwin" && execSync(`chmod +x ${__dirname}/bin/${bin}`); + const executable = `${__dirname}/bin/${bin}`; - execSync( - `${__dirname}/bin/${bin} -b -i ${pluginPath} -o ${outputPath}` - ); + try { + platform === "darwin" && execSync(`chmod +x ${executable}`); + execSync(`${executable} -b -i ${pluginPath} -o ${outputPath}`); } catch (e) { - this.error(`Plugin build failed`); - this.error(e); + this.error("Error while packaging the plugin"); } }, }; diff --git a/package-lock.json b/package-lock.json index 4c6bb72..ed4e704 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,15 +1,17 @@ { - "name": "@fcannizzaro/rollup-elgato-distribution-tool", - "version": "1.0.0", + "name": "@fcannizzaro/rollup-stream-deck-package", + "version": "1.0.3", "lockfileVersion": 3, "requires": true, "packages": { "": { - "name": "@fcannizzaro/rollup-elgato-distribution-tool", - "version": "1.0.0", + "name": "@fcannizzaro/rollup-stream-deck-package", + "version": "1.0.3", "license": "MIT", "devDependencies": { - "rollup": "^4.9.1" + "@types/node": "^20.10.5", + "rollup": "^4.9.1", + "typescript": "^5.3.3" } }, "node_modules/@rollup/rollup-android-arm-eabi": { @@ -181,6 +183,15 @@ "win32" ] }, + "node_modules/@types/node": { + "version": "20.10.5", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.10.5.tgz", + "integrity": "sha512-nNPsNE65wjMxEKI93yOP+NPGGBJz/PoN3kZsVLee0XMiJolxSekEVD8wRwBUBqkwc7UWop0edW50yrCQW4CyRw==", + "dev": true, + "dependencies": { + "undici-types": "~5.26.4" + } + }, "node_modules/fsevents": { "version": "2.3.3", "resolved": "https://registry.npmjs.org/fsevents/-/fsevents-2.3.3.tgz", @@ -223,6 +234,25 @@ "@rollup/rollup-win32-x64-msvc": "4.9.1", "fsevents": "~2.3.2" } + }, + "node_modules/typescript": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", + "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + }, + "node_modules/undici-types": { + "version": "5.26.5", + "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", + "integrity": "sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==", + "dev": true } } } diff --git a/package.json b/package.json index 2d40e87..ed70261 100644 --- a/package.json +++ b/package.json @@ -1,8 +1,11 @@ { "name": "@fcannizzaro/rollup-stream-deck-package", - "version": "1.0.3", + "version": "1.0.4", "description": "Rollup plugin to create a distribution package for Elgato Stream Deck plguins", "author": "Francesco Saverio Cannizzaro ", + "type": "module", + "main": "./index.js", + "types": "./index.d.ts", "license": "MIT", "repository": "https://github.com/fcannizzaro/rollup-stream-deck-package", "keywords": [ @@ -11,13 +14,15 @@ "elgato", "stream-deck" ], - "publishConfig": { - "provenance": true + "scripts": { + "build": "tsc --declaration" }, - "type": "module", - "main": "./index.js", - "types": "./index.d.ts", "devDependencies": { - "rollup": "^4.9.1" + "@types/node": "^20.10.5", + "rollup": "^4.9.1", + "typescript": "^5.3.3" + }, + "publishConfig": { + "provenance": true } } diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..d6a5dcf --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */, + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "NodeNext" /* Specify what module code is generated. */, + // "rootDir": "./", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + // "outDir": "./", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */, + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */, + + /* Type Checking */ + "strict": true /* Enable all strict type-checking options. */, + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}