Skip to content

Commit dd74e19

Browse files
committed
convert to typescript
1 parent 63d358f commit dd74e19

File tree

7 files changed

+186
-46
lines changed

7 files changed

+186
-46
lines changed

.github/workflows/publish-package.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ jobs:
1616
registry-url: "https://registry.npmjs.org"
1717
- run: npm install -g npm
1818
- run: npm ci
19+
- run: npm run build
1920
- run: npm publish --provenance --access public
2021
env:
2122
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.npmignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
.github
2+
index.ts
3+
tsconfig.json

index.d.ts

Lines changed: 0 additions & 15 deletions
This file was deleted.

index.js renamed to index.ts

Lines changed: 27 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,41 @@
11
import { execSync } from "child_process";
2+
import type { Plugin } from "rollup";
3+
import path from "path";
24
import os from "os";
35
import fs from "fs";
4-
import path from "path";
56
import url from "url";
67

78
const __dirname = url.fileURLToPath(new URL(".", import.meta.url));
89

10+
interface PluginOptions {
11+
/**
12+
* Path of the .sdPlugin directory
13+
*/
14+
plugin: string;
15+
16+
/**
17+
* Path where put the .streamdeckPlugin package
18+
*/
19+
output?: string;
20+
}
21+
22+
const Binaries: Record<string, string> = {
23+
win32: "DistributionTool.exe",
24+
darwin: "DistributionTool",
25+
};
26+
927
/**
10-
*
11-
* @param {import(".").RollupElgatoDistributionToolPluginOptions} options
12-
* @returns {import("rollup").Plugin}
28+
* Rollup plugin to package a .sdPlugin directory into a .streamdeckPlugin package using the Elgato Distribution Tool
1329
*/
14-
export default function (options) {
30+
export default function (options: PluginOptions): Plugin {
1531
if (!options.plugin) {
1632
throw new Error("Missing plugin param");
1733
}
1834
return {
1935
name: "stream-deck-package",
2036
closeBundle() {
2137
const platform = os.platform();
22-
23-
const bin =
24-
platform === "win32"
25-
? "DistributionTool.exe"
26-
: platform === "darwin"
27-
? "DistributionTool"
28-
: undefined;
38+
const bin = Binaries[platform];
2939

3040
if (!bin) {
3141
return this.error(`Unsupported platform ${platform}`);
@@ -54,15 +64,13 @@ export default function (options) {
5464
fs.rmSync(filePath);
5565
}
5666

57-
try {
58-
platform === "darwin" && execSync(`chmod +x ${__dirname}/bin/${bin}`);
67+
const executable = `${__dirname}/bin/${bin}`;
5968

60-
execSync(
61-
`${__dirname}/bin/${bin} -b -i ${pluginPath} -o ${outputPath}`
62-
);
69+
try {
70+
platform === "darwin" && execSync(`chmod +x ${executable}`);
71+
execSync(`${executable} -b -i ${pluginPath} -o ${outputPath}`);
6372
} catch (e) {
64-
this.error(`Plugin build failed`);
65-
this.error(e);
73+
this.error("Error while packaging the plugin");
6674
}
6775
},
6876
};

package-lock.json

Lines changed: 35 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
11
{
22
"name": "@fcannizzaro/rollup-stream-deck-package",
3-
"version": "1.0.3",
3+
"version": "1.0.4",
44
"description": "Rollup plugin to create a distribution package for Elgato Stream Deck plguins",
55
"author": "Francesco Saverio Cannizzaro <fcannizzaro>",
6+
"type": "module",
7+
"main": "./index.js",
8+
"types": "./index.d.ts",
69
"license": "MIT",
710
"repository": "https://github.com/fcannizzaro/rollup-stream-deck-package",
811
"keywords": [
@@ -11,13 +14,15 @@
1114
"elgato",
1215
"stream-deck"
1316
],
14-
"publishConfig": {
15-
"provenance": true
17+
"scripts": {
18+
"build": "tsc --declaration"
1619
},
17-
"type": "module",
18-
"main": "./index.js",
19-
"types": "./index.d.ts",
2020
"devDependencies": {
21-
"rollup": "^4.9.1"
21+
"@types/node": "^20.10.5",
22+
"rollup": "^4.9.1",
23+
"typescript": "^5.3.3"
24+
},
25+
"publishConfig": {
26+
"provenance": true
2227
}
2328
}

tsconfig.json

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig to read more about this file */
4+
5+
/* Projects */
6+
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8+
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12+
13+
/* Language and Environment */
14+
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
15+
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16+
// "jsx": "preserve", /* Specify what JSX code is generated. */
17+
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
18+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
19+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
20+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
21+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
22+
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
23+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
24+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
25+
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
26+
27+
/* Modules */
28+
"module": "NodeNext" /* Specify what module code is generated. */,
29+
// "rootDir": "./", /* Specify the root folder within your source files. */
30+
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
31+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
32+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
33+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
34+
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
35+
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
36+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
37+
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
38+
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
39+
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
40+
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
41+
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
42+
// "resolveJsonModule": true, /* Enable importing .json files. */
43+
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
44+
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
45+
46+
/* JavaScript Support */
47+
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
48+
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
49+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
50+
51+
/* Emit */
52+
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
53+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
54+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
55+
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
56+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
57+
// "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. */
58+
// "outDir": "./", /* Specify an output folder for all emitted files. */
59+
// "removeComments": true, /* Disable emitting comments. */
60+
// "noEmit": true, /* Disable emitting files from a compilation. */
61+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
62+
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
63+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
64+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
65+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
66+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
67+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
68+
// "newLine": "crlf", /* Set the newline character for emitting files. */
69+
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
70+
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
71+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
72+
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
73+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
74+
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
75+
76+
/* Interop Constraints */
77+
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
78+
// "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. */
79+
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
80+
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
81+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
82+
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
83+
84+
/* Type Checking */
85+
"strict": true /* Enable all strict type-checking options. */,
86+
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
87+
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
88+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
89+
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
90+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
91+
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
92+
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
93+
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
94+
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
95+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
96+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
97+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
98+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
99+
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
100+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
101+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
102+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
103+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
104+
105+
/* Completeness */
106+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
107+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
108+
}
109+
}

0 commit comments

Comments
 (0)