JavaScript Support - Revision history

Ryo Sangnoir: /* Library Functions */ neat trick for javascript scripts

2022-12-13T08:48:06Z

Library Functions: neat trick for javascript scripts

← Older revision		Revision as of 08:48, 13 December 2022
Line 13:		Line 13:
	const kolmafia = require("kolmafia");		const kolmafia = require("kolmafia");
	kolmafia.print("Hello, " + kolmafia.myName());		kolmafia.print("Hello, " + kolmafia.myName());

			// Alternative to have all functions in the global namespace
			Object.assign(globalThis, require("kolmafia"));
			print("Hello, " + myName());
	</syntaxhighlight>		</syntaxhighlight>

Philmasterplus: /* Code Checking */ Update ESLint config

2021-08-31T13:49:42Z

Code Checking: Update ESLint config

← Older revision		Revision as of 13:49, 31 August 2021
Line 211:		Line 211:
	},		},
	{		{
	"selector": "RestElement",		"selector": "RestElement, SpreadElement",
	"message": "Rhino does not support spread/rest syntax"		"message": "Rhino does not support spread/rest syntax"
	},		},

Philmasterplus: /* Code Checking */ Update ESLint config

2021-08-11T08:28:33Z

Code Checking: Update ESLint config

← Older revision		Revision as of 08:28, 11 August 2021
Line 197:		Line 197:
	"selector": "ClassDeclaration, ClassExpression",		"selector": "ClassDeclaration, ClassExpression",
	"message": "Rhino does not support ES2015 classes"		"message": "Rhino does not support ES2015 classes"
			},
			{
			"selector": ":matches(ForInStatement, ForOfStatement, ForStatement) > VariableDeclaration[kind=const]",
			"message": "Rhino does not support const declarations in the head of for-loops"
	},		},
	{		{

Philmasterplus: /* Code Checking */ Update ESLint config

2021-08-10T11:10:40Z

Code Checking: Update ESLint config

← Older revision		Revision as of 11:10, 10 August 2021
Line 130:		Line 130:
	* Syntax		* Syntax
	** Spread/rest syntax (<code>...</code>)		** Spread/rest syntax (<code>...</code>)
			** Object destructuring in assignments (variable declarations are OK)
	** Template string literals: Backtick string literals (<code>``</code>) are not a syntax error, but are treated as plain string literals.		** Template string literals: Backtick string literals (<code>``</code>) are not a syntax error, but are treated as plain string literals.
	** Classes		** Classes
Line 185:		Line 186:
	"no-restricted-syntax": [		"no-restricted-syntax": [
	"error",		"error",
			{
			"selector": "AssignmentExpression > ObjectPattern",
			"message": "Rhino does not support object destructuring in assignments (variable declarations are OK)"
			},
	{		{
	"selector": "AssignmentPattern",		"selector": "AssignmentPattern",

Philmasterplus: Shorthand properties are not supported yet!

2021-08-10T08:36:21Z

Shorthand properties are not supported yet!

← Older revision		Revision as of 08:36, 10 August 2021
Line 135:		Line 135:
	** Default function parameters		** Default function parameters
	** Computed property names		** Computed property names
			** Shorthand property names (in object literals)
	Exponentiation operator (<code></code>)		Exponentiation operator (<code></code>)
	** Async/Await		** Async/Await
Line 191:		Line 192:
	"selector": "ClassDeclaration, ClassExpression",		"selector": "ClassDeclaration, ClassExpression",
	"message": "Rhino does not support ES2015 classes"		"message": "Rhino does not support ES2015 classes"
			},
			{
			"selector": "ObjectExpression > Property[shorthand=true]",
			"message": "Rhino does not support shorthand object properties"
	},		},
	{		{

Philmasterplus: /* Code Checking */ Update ESLint config

2021-08-10T07:21:30Z

Code Checking: Update ESLint config

← Older revision		Revision as of 07:21, 10 August 2021
Line 184:		Line 184:
	"no-restricted-syntax": [		"no-restricted-syntax": [
	"error",		"error",
	"AssignmentPattern",		{
	"ClassDeclaration",		"selector": "AssignmentPattern",
	"~~ClassExpression~~",		"message": "Rhino does not support default values for function parameters and array/object destructuring"
	"RestElement",		},
	"TemplateLiteral"		{
			"selector": "ClassDeclaration, ClassExpression",
			"message": "Rhino does not support ES2015 classes"
			},
			{
			"selector": "Property[computed=true]",
			"message": "Rhino does not support computed object properties"
			},
			{
			"selector": "RestElement",
			"message": "Rhino does not support spread/rest syntax"
			},
			{
			"selector": "TemplateLiteral",
			"message": "Rhino does not support template string literals"
			}
	]		]
	}		}

Philmasterplus: /* Code Checking */ Update ESLint config

2021-08-10T06:56:04Z

Code Checking: Update ESLint config

@@ Line 150: / Line 150: @@
 You can set up [https://eslint.org/ ESLint] to check your code for errors.
-The following ESLint configuration (<code>.eslintrc.json</code>) checks if your JavaScript code uses features unsupported by KoLmafia.
+The following ESLint configuration (<code>.eslintrc.json</code>) checks if your JavaScript code uses features unsupported by KoLmafia, and prevents ESLint from complaining about KoLmafia builtins.
 <syntaxhighlight lang="json">
@@ Line 157: / Line 157: @@
      "commonjs": true,
      "es6": true
    },
    "parserOptions": {
@@ Line 162: / Line 182: @@
    },
    "rules": {
      "no-restricted-syntax": [
        "error",

Philmasterplus at 06:22, 10 August 2021

2021-08-10T06:22:28Z

@@ Line 145: / Line 145: @@
 === Other ===
 Most JavaScript globals available in browsers and/or server-side environments like Node.js are ''not'' available. This includes <code>alert()</code>, <code>console.log()</code>, and <code>setTimeout()</code>.
 == Transpiling ==
-Folks with experience doing JavaScript web development are likely well-acquainted with tools such as Babel, Webpack, and TypeScript. These tools allow you to write modern JavaScript code. and can transpile the code down to an older version of JS supported by a particular engine. That approach works well with Rhino.
+Various tools as Babel, Webpack, and TypeScript can convert modern JavaScript code (or another programming language) to legacy syntax supported by Rhino. These tools are called "transpilers". These tools allow you to enjoy the convenience and safety of modern language features, while still generating code that runs on KoLmafia.
 * Babel: As of r20558, you will still need to apply several patches to Babel in order to get babel-preset-env to work. See [https://github.com/phulin/bean-casual/tree/ts] for an example of a working Babel/Webpack/Typescript configuration; you'll need the configuration files and also the patches, which can be applied with patch-package.
-=== TypeScript ===
+=== [https://www.typescriptlang.org/ TypeScript] ===
 If you use TypeScript without Babel, you can set the <code>[https://www.typescriptlang.org/tsconfig#target target]</code> to <kbd>"ES5"</kbd>.

Philmasterplus: Add unsupported syntax

2021-08-10T05:04:54Z

Add unsupported syntax

← Older revision		Revision as of 05:04, 10 August 2021
Line 135:		Line 135:
	** Default function parameters		** Default function parameters
	** Computed property names		** Computed property names
			Exponentiation operator (<code></code>)
	** Async/Await		** Async/Await
	** Trailing commas in function definitions (oddly, trailing commas are supported in function ''calls'')		** Trailing commas in function definitions (oddly, trailing commas are supported in function ''calls'')

Philmasterplus: Add "History" section

2021-07-02T12:04:26Z

Add "History" section

← Older revision		Revision as of 12:04, 2 July 2021
Line 1:		Line 1:
	As of revision 20509, KoLmafia supports scripting in JavaScript! You can run JS code from the CLI using <code>js <nowiki><code></nowiki></code>, and you can call scripts through any of the normal methods. Consult and "lifecycle" scripts (e.g. <code>betweenBattleScript</code>) are supported ~~as well as of revision 20519.~~ '''This support is still experimental - you have been warned.'''		As of revision 20509, KoLmafia supports scripting in JavaScript! You can run JS code from the CLI using <code>js <nowiki><code></nowiki></code>, and you can call scripts through any of the normal methods. Consult and "lifecycle" scripts (e.g. <code>betweenBattleScript</code>) are supported, too! '''This support is still experimental - you have been warned.'''

	== Basics ==		== Basics ==
Line 38:		Line 38:
	> js print("My name is " + myName())		> js print("My name is " + myName())
	My name is <playername>		My name is <playername>

	~~Note: All library functions that return a {{type\|boolean}} will throw an exception instead of returning <code>false</code>.~~

	=== Importing and Exporting ===		=== Importing and Exporting ===
Line 84:		Line 82:
	Enumerated objects support the <code>toString()</code> method, which acts like the {{f\|to_string}} ASH function.		Enumerated objects support the <code>toString()</code> method, which acts like the {{f\|to_string}} ASH function.

	~~Note: As of r20620, KoLmafia no longer provides a custom <code>valueOf()</code> method for enumerated objects. This means that you can no longer~~ retrieve the ID of ~~an item, effect, or familiar using <code>Number()</code>. Instead~~, use the {{f\|to_int\|toInt}} library function.		To retrieve the numeric ID of enumerated objects, use the {{f\|to_int\|toInt}} library function:

	~~Example:~~
	<syntaxhighlight lang="js">		<syntaxhighlight lang="js">
	let item = Item.get("filthy lucre");		let item = Item.get("filthy lucre");
Line 189:		Line 186:

	If you use a bundler such as [https://webpack.js.org/ Webpack] or [https://rollupjs.org/ Rollup], you should change the <code>module</code> to <kbd>"ES2015"</kbd>, and let the bundlers convert your code to CommonJS.		If you use a bundler such as [https://webpack.js.org/ Webpack] or [https://rollupjs.org/ Rollup], you should change the <code>module</code> to <kbd>"ES2015"</kbd>, and let the bundlers convert your code to CommonJS.

			== History ==
			* [https://kolmafia.us/threads/20520-this-is-a-big-patch-to-set-up-consult-scripts-lifecycle-scripts-choiceadventurescript.25660/ r20520]: Lifecycle scripts now support JavaScript.
			* [https://kolmafia.us/threads/20620-remove-valueof-as-per-philmasterplus.25845/ r20620]: Enumerated objects no longer provide a custom <code>valueOf()</code> method. Use {{f\|to_int\|toInt}} instead.
			* [https://kolmafia.us/threads/20780-javascript-runtime-no-longer-interrupts-when-library-functions-return-false.26174/ r20780]: When calling ASH runtime library functions from JavaScript, functions that return a {{type\|boolean}} will return <code>false</code> on failure instead of throwing a string as an exception.