@makano/rew 1.3.3 → 1.3.4

package/lib/rew/cli/cli.js

@@ -6,7 +6,6 @@ const path = require('path');
 const { hideBin } = require('yargs/helpers');
 const { existsSync, readFileSync, writeFileSync, statSync, unlinkSync } = require('fs');
 const { log } = require('./log');
-const rune = require('../pkgs/rune');
 const { to_qrew, from_qrew } = require('../qrew/compile');
 const { findAppInfo } = require('../misc/findAppInfo');
 const { input } = require('../functions/stdout');
@@ -74,7 +73,11 @@ yargs(hideBin(process.argv))
 				alias: 'c',
 				describe: 'Compile and output the javascript',
 				type: 'boolean',
-			});
+			})
+			.example('rew exec "print \'hi\'"', "Executes code")
+			.example('echo "print \\hi\'" | rew exec', "Executes code from pipe")
+			.example('rew exec "print \'hi\'" -- arg1', "Executes code with arguments")
+			.example('echo "print \\hi\'" | rew exec -- arg1', "Executes code from pipe with arguments");
 		},
 		async (argv) => {
 			const replFile = '/tmp/rew-'+generateRandomID()+'-'+Date.now()+'.coffee';
@@ -116,7 +119,17 @@ yargs(hideBin(process.argv))
 					describe: 'Value to set (only used with "set" command)',
 					type: 'string',
 					default: '',
-				});
+				})
+				.example('rew conf get', 'Get all the possible conf-sets')
+				.example('rew conf get app.package', 'Get all files for app.package')
+				.example('rew conf get app.package/_default', 'Get all default configs for app.package')
+				.example('rew conf get app.package/[optionGroup]', 'Get all configs for app.package/[optionGroup]')
+				.example('rew conf get app.package/[optionGroup] [key]', 'Get value of \'key\' for app.package/[optionGroup]')
+				.example('rew conf get app.package/app', 'List all files for the app if the app is installed')
+				.example('rew conf get app.package/path/to/file', 'Reads file or lists directory')
+
+				.example('rew conf set app.package/[optionGroup] [key] "[value]"', "Sets 'key' to 'value' for app.package/[optionGroup]")
+				.example('rew conf remove app.package/[optionGroup] [key]', "Removes 'key' from app.package/[optionGroup]");
 		},
 		(argv) => {
 			const { command, path, key, value } = argv;
@@ -152,21 +165,20 @@ yargs(hideBin(process.argv))
 				describe: `Use default options`,
 				type: 'boolean',
 				default: false
-			});
+			})
+			.example('rew create /path/to/project', 'Open interactive shell to create app at path')
+			.example('rew create -i /path/to/project', 'Create without interactive shell')
+			.example('rew create -n package.name /path/to/project', 'Create with "-n" as a package name')
+			.example('rew create -t /path/to/project', 'Enable types')
+			.example('rew create -c /path/to/project', 'Enable civet for main')
+			.example('rew create -g /path/to/project', 'Setup git')
+			.example('rew create -git /path/to/project', '(Recommended) Setup git, no interactive shell, enable types.')
+			.example('rew create -gitn package.name /path/to/project', '(Recommended) Setup git, no interactive shell, enable types, set package name.');
 		},
 		(argv) => {
 			require('./utils').createProject(argv.path, argv);
 		},
 	)
-	.command(
-		'rune-keygen',
-		'Generate a rune encryption key',
-		(yargs) => {
-		},
-		(argv) => {
-			console.log('Encryption Key:', rune({}).genKey(input('Secret Value: ') || null));
-		},
-	)
 	.command(
 		'run <path | package>',
 		'Run an app',
@@ -193,7 +205,12 @@ yargs(hideBin(process.argv))
 					alias: 't',
 					describe: 'Builds to a .js before running, only used when --build is passed',
 					type: 'boolean',
-				});
+				})
+				.example('rew run .', "Run the current directory as an app")
+				.example('rew run package.name', "Run 'package.name' if it's installed")
+				.example('rew run . -b', "Build files into .qrew before running")
+				.example('rew run . --dev -b', `If current entry file ends with .qrew it changes it to .coffee or ${REW_FILE_TYPE.EXTENSION} instead, and builds it before running the build`)
+				.example('rew run . -e test', "Runs the 'test' entry from the 'app.yaml' if exists")
 		},
 		(argv) => {
 			require('./utils').runApp(argv.path, argv);
@@ -289,7 +306,14 @@ yargs(hideBin(process.argv))
 				alias: 'y',
 				describe: 'Auto yes',
 				type: 'boolean',
-			});
+			})
+			.example('rew install /path/to/app', "Installs path into the rew conf directory.")
+			.example('rew install -r /path/to/app', "Installs all the required libraries/apps for the specified app.")
+			.example('rew install github:username/repo', "Clones the repo and installs it to rew")
+			.example('rew install -yu github:username/repo', "Installs from github without asking for confirmation and auto updates")
+			.example('rew install github:username/repo@branch', "Installs a specific branch from github(default is main)")
+			.example('rew install github:username/repo#commit', "Installs a specific commit from github(default is latest)")
+			.example('rew install github:username/repo@branch#commit', "Installs a specific commit from a branch in a github repository");
 		},
 		async (argv) => {
 			if (argv.requirements) require('./utils').installReq(argv.path, argv);
@@ -307,7 +331,9 @@ yargs(hideBin(process.argv))
 				alias: 'a',
 				describe: 'Remove the configs as well',
 				type: 'boolean',
-			});
+			})
+			.example('rew uninstall package.name', "Uninstalls app package.name, but keeps the data/configs")
+			.example('rew uninstall -a package.name', "Uninstalls app package.name entirely");
 		},
 		async (argv) => {
 			require('./utils').uninstall(argv.package, argv.all);
@@ -373,10 +399,12 @@ yargs(hideBin(process.argv))
 			yargs.positional('command', {
 				describe: 'Misc command name',
 				type: 'string',
-			});
+			})
+			.example('rew misc types', 'Fixes types for libraries and rew runtime')
+			.example('rew misc keygen', 'Generate a rune encryption key')
 		},
 		(argv) => {
-			require('./miscUtils')[argv.command](...argv._.slice(1));
+			require('./miscUtils')[argv.command]?.(...argv._.slice(1));
 		},
 	)
 	.command(

package/lib/rew/cli/miscUtils.js

@@ -1,9 +1,11 @@
 const { findAppInfo } = require("../misc/findAppInfo");
 const { log } = require("./log");
 const colors = require('colors');
+const { input } = require('../functions/stdout');
 const path = require('path');
 const fs = require('fs');
 const { CONFIG_PATH } = require("../const/config_path");
+const rune = require("../pkgs/rune");
 
 module.exports = {
 	types(projectPath){
@@ -37,5 +39,5 @@ module.exports = {
       if(fs.existsSync(p)) fs.copyFileSync(p, path.join(projectPath, 'node_modules/@types/rew/'+filename));
     });
 	},
-
+  'keygen': () => console.log('Encryption Key:', rune({}).genKey(input('Secret Value: ') || null))
 }

package/lib/rew/cli/utils.js

@@ -4,9 +4,7 @@ const conf = require('../pkgs/conf');
 const jsYaml = require('js-yaml');
 const readline = require('readline');
 const { log, logget } = require('./log');
-const { fork, execSync, exec } = require('child_process');
-const { run } = require('../main');
-const { generateRandomID } = require('../functions/id');
+const { execSync } = require('child_process');
 const { compile } = require('../modules/compiler');
 const { to_qrew } = require('../qrew/compile');
 const { findAppInfo } = require('../misc/findAppInfo');
@@ -100,7 +98,10 @@ module.exports = {
 				confObj.types = ['rew'];
 			}
 			fs.writeFileSync(confPath, jsYaml.dump(confObj));
-			fs.writeFileSync(entryFile, `print("Hello World!")`);
+			fs.writeFileSync(entryFile, `using namespace std::ns ->
+  define Main class
+    @main: (argv) ->
+      print 'Hello, World!'`);
 			fs.mkdirSync(path.join(projectPath, 'assets'), { recursive: true });
 			if (project.git) {
 				fs.writeFileSync(path.join(projectPath, '.gitignore'), `node_modules/\npackage-lock.json`);

package/lib/rew/pkgs/conf.js

@@ -66,7 +66,7 @@ module.exports = (context) => ({
 		};
 
 		const createOptionCenter = (name, defaults = {}) => {
-			const optionRoot = path.join(rootPath, name + '.yaml');
+			const optionRoot = path.join(rootPath, name.endsWith('.yaml') ? name : name + '.yaml');
 			if (!fs.existsSync(path.dirname(optionRoot))) fs.mkdirSync(path.dirname(optionRoot), { recursive: true });
 			if (!fs.existsSync(optionRoot)) {
 				conf[name] = defaults;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@makano/rew",
-  "version": "1.3.3",
+  "version": "1.3.4",
   "description": "A simple coffescript runtime and app manager",
   "main": "main.js",
   "directories": {