npm - @signageos/cli - Versions diffs - 2.0.0 → 2.2.0 - Mend

@signageos/cli 2.0.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (27) hide show

package/README.md CHANGED Viewed

@@ -74,7 +74,7 @@ npm run build
 | --target-dir *(optional)*   | Generate applet project to directory                          | ${PWD}/${name} |
 | --npm-registry *(optional)* | NPM registry URL (for private npm)                            |                |
 | --language *(optional)*     | Generate applet with "typescript" or "javascript" source code | STDIN          |
-| --bundler *(optional)*      | Generate applet with "webpack" or "esbuild" bundler           | webpack        |
+| --bundler *(optional)*      | Generate applet with "webpack" or "rspack"                    | webpack        |
 | --git *(optional)*          | Initialize applet as git repository "yes" or "no"             | no             |
 > ! Windows users note:

package/dist/Applet/Generate/Templates/index.css.template ADDED Viewed

@@ -0,0 +1,4 @@
+body {
+	background-color: wheat;
+	text-align: center;
+}

package/dist/Applet/Generate/Templates/index.html.template ADDED Viewed

@@ -0,0 +1,12 @@
+<html lang="en">
+<head>
+	<meta charset="utf-8" />
+	<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no" />
+	<meta name="theme-color" content="#000000" />
+	<title>${title}</title>
+</head>
+<body>
+	<h1>Hello ${title}</h1>
+	<div id="root"></div>
+</body>
+</html>

package/dist/Applet/Generate/Templates/index.js.template ADDED Viewed

@@ -0,0 +1,11 @@
+import './index.css';
+import sos from '@signageos/front-applet';
+// Wait on sos data are ready (https://docs.signageos.io/api/js/content/latest/js-applet-basics#onready)
+sos.onReady().then(async function () {
+	const contentElement = document.getElementById('root');
+	if (contentElement) {
+		console.log('sOS is ready');
+		contentElement.innerHTML = 'sOS is ready';
+	}
+});

package/dist/Applet/Generate/Templates/rspack.config.mjs.template ADDED Viewed

@@ -0,0 +1,48 @@
+import { rspack } from '@rspack/core';
+import { defineConfig } from '@rspack/cli';
+import SignageOSPlugin from '@signageos/webpack-plugin';
+export default defineConfig({
+  entry: {
+		main: './src/index', // Universal configuration works for .js and .ts
+	},
+	resolve: {
+		extensionAlias: {
+			'.js': ['.ts', '.tsx', '.js'], // First search for .ts, than .js
+		},
+		extensions: ['.ts', '.tsx', '.js'],
+	},
+	target: ['web', 'es5'],
+	output: {
+		filename: 'index.js',
+	},
+	module: {
+		rules: [
+			{
+				test: /\.js$/,
+				exclude: /node_modules/,
+				use: {
+					loader: 'babel-loader',
+					options: {
+						presets: ['@babel/preset-env'], // Ensure ES5 transpilation
+						cacheDirectory: true, // Speed up subsequent builds
+					},
+				},
+			},
+			{
+				test: /^(.(?!.module.css))*.css$/,
+				use: ['style-loader', 'css-loader'],
+			},
+			{ test: /\.tsx?$/, loader: 'ts-loader' },
+		],
+	},
+	plugins: [
+		new rspack.HtmlRspackPlugin({
+			template: 'public/index.html',
+		}),
+		new SignageOSPlugin(),
+	],
+  infrastructureLogging: {
+		level: 'warn',
+	},
+});

package/dist/Applet/Generate/Templates/tsconfig.js.template ADDED Viewed

@@ -0,0 +1,35 @@
+{
+	"compilerOptions": {
+		/* Sensible defaults for most projects */
+		"module": "nodenext",
+		"moduleResolution": "nodenext",
+		"target": "es5",
+	  	"lib": ["es6", "dom"],
+	  	"sourceMap": true,
+		"esModuleInterop": true,
+		"skipLibCheck": true,
+		"resolveJsonModule": true,
+		"moduleDetection": "force",
+		"isolatedModules": true,
+		"forceConsistentCasingInFileNames": true,
+		/* Applet specific */
+		"downlevelIteration": true,
+		/* Type checking */
+		"strict": true,
+		"noUncheckedIndexedAccess": true,
+		"noUnusedParameters": true,
+		"noUnusedLocals": true,
+		/* Features */
+		"experimentalDecorators": true,
+		"emitDecoratorMetadata": true,
+		"jsx": "react",
+		/* Typecheck javascript */
+		"allowJs": true,
+		"checkJs": true
+	},
+	"include": ["src/**/*.ts", "src/*.ts"]
+}

package/dist/Applet/Generate/Templates/webpack.config.js.template ADDED Viewed

@@ -0,0 +1,47 @@
+const HtmlWebpackPlugin = require('html-webpack-plugin');
+const SignageOSPlugin = require('@signageos/webpack-plugin')
+exports = module.exports = {
+  	entry: {
+		main: './src/index', // Universal configuration works for .js and .ts
+	},
+	resolve: {
+		extensionAlias: {
+			'.js': ['.ts', '.tsx', '.js'], // First search for .ts, than .js
+		},
+		extensions: ['.ts', '.tsx', '.js'],
+	},
+	target: ['web', 'es5'],
+	output: {
+		filename: 'index.js',
+	},
+	module: {
+		rules: [
+			{
+				test: /\.js$/,
+				exclude: /node_modules/,
+				use: {
+					loader: 'babel-loader',
+					options: {
+						presets: ['@babel/preset-env'], // Ensure ES5 transpilation
+						cacheDirectory: true, // Speed up subsequent builds
+					},
+				},
+			},
+			{
+				test: /^(.(?!.module.css))*.css$/,
+				use: ['style-loader', 'css-loader'],
+			},
+			{ test: /\.tsx?$/, loader: 'ts-loader' },
+		],
+	},
+	plugins: [
+		new HtmlWebpackPlugin({
+			template: 'public/index.html',
+		}),
+		new SignageOSPlugin(),
+	],
+	infrastructureLogging: {
+		level: 'warn',
+	},
+};

package/dist/Applet/Generate/appletGenerateCommand.d.ts CHANGED Viewed

@@ -23,13 +23,38 @@ declare const OPTION_LIST: readonly [{
 }, {
     readonly name: "bundler";
     readonly type: StringConstructor;
-    readonly description: "Generate applet with \"webpack\" (default) or \"esbuild\" bundler";
-    readonly defaultValue: "webpack";
+    readonly description: "Generate applet with \"webpack\" (default) or \"rspack\"";
 }, {
     readonly name: "git";
     readonly type: StringConstructor;
     readonly description: "Init applet as git repository \"no\" (default) or \"yes\"";
+    readonly defaultValue: "no";
 }];
+/**
+ * Command definition for generating a new applet.
+ * This command facilitates the creation of a basic applet sample with configurable options such as
+ * language, bundler, git initialization, and npm registry. It generates the necessary files and
+ * installs dependencies based on the selected options.
+ * @param {Object} options - The options for generating the applet
+ * @param {string} options.name - The name of the applet
+ * @param {string} options.appletVersion - The version of the applet
+ * @param {string} options.targetDir - The target directory for the applet
+ * @param {string} options.npmRegistry - The npm registry URL
+ * @param {string} options.language - The language of the applet (typescript or javascript)
+ * @param {string} options.bundler - The bundler to use (webpack or rspack)
+ * @param {string} options.git - Whether to initialize a git repository (yes or no)
+ * @returns {Promise<void>} - A promise that resolves when the applet is generated
+ * @example
+ * appletGenerate.run({
+ *   name: 'my-applet',
+ *   appletVersion: '1.0.0',
+ *   targetDir: './output',
+ *   npmRegistry: 'https://registry.npmjs.org/',
+ *   language: 'typescript',
+ *   bundler: 'webpack',
+ *   git: 'yes',
+ * });
+ */
 export declare const appletGenerate: {
     name: "generate";
     description: string;
@@ -57,12 +82,12 @@ export declare const appletGenerate: {
     }, {
         readonly name: "bundler";
         readonly type: StringConstructor;
-        readonly description: "Generate applet with \"webpack\" (default) or \"esbuild\" bundler";
-        readonly defaultValue: "webpack";
+        readonly description: "Generate applet with \"webpack\" (default) or \"rspack\"";
     }, {
         readonly name: "git";
         readonly type: StringConstructor;
         readonly description: "Init applet as git repository \"no\" (default) or \"yes\"";
+        readonly defaultValue: "no";
     }];
     commands: never[];
     run(options: CommandLineOptions<typeof OPTION_LIST>): Promise<void>;