arche-highlight 0.5.5 → 0.6.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 (3) hide show
  1. package/LICENSE +5 -0
  2. package/README.md +34 -18
  3. package/package.json +1 -1
package/LICENSE ADDED
@@ -0,0 +1,5 @@
1
+ The CLOUŢ Free and Open Source Software License (CFOSS)
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so.
4
+
5
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE, OR IN THE USE OF OR OTHER DEALINGS OF THE SOFTWARE.
package/README.md CHANGED
@@ -65,24 +65,40 @@ Return:
65
65
 
66
66
  ### JavaScript Classes
67
67
  The following JavaScript classes are added to the code as `span` elements of the parsed React Element or HTML:
68
- * `comment` - single line (`//`) or multi-line comments (`/* */`)
69
- * `number` - numbers, for example `1`, `0`, `2.5`, `-1`, `100`
70
- * `string` - strings, for example `"a"`, `'a'`, `"This is a string."`
71
- * `template-literal` - template literals, for example `` `This is a${x} ${y} literal` ``
68
+ * `comment` - single line (`//`) or multi-line comments (`/* */`).
69
+ * `number` - numbers, for example `1`, `0`, `2.5`, `-1`, `100`.
70
+ * `string` - strings, for example `"a"`, `'a'`, `"This is a string."`.
71
+ * `template-literal` - template literals, for example `` `This is a${x} ${y} literal` ``.
72
72
  * `template-variable` - variables in template literals, for example the `${x}` and `${y}` in the template literal above.
73
- * `bigint` - JavaScript BigInts, for example `2n`
74
- * `variable-declaration-keyword` - `var`, `const`, `let`
75
- * `keyword` - `import`, `new`, `async`, `await`, `for`, `while`, `of`
76
- * `function-keyword` - the `function` keyword for function declarations, for example `function f() {}`
77
- * `arrow-function-operator` - the arrow function operator `=>` for arrow function declarations, for example `const fn = () => {}`
73
+ * `bigint` - JavaScript BigInts, for example `2n`.
74
+ * `variable-declaration-keyword` - `var`, `const`, `let`.
75
+ * `keyword` - `import`, `new`, `async`, `await`, `for`, `while`, `of`.
76
+ * `function-keyword` - the `function` keyword for function declarations, for example `function f() {}`.
77
+ * `arrow-function-operator` - the arrow function operator `=>` for arrow function declarations, for example `const fn = () => {}`.
78
78
  * `function-name` - the name of a function, either in a function declaration or as the function of a function call, for example in `function f() {}`, `f` would have a `function-name` class, and in `add(1, 2)`, `add` would have a `function-name` class.
79
- * `operator` - the JavaScript operators `+`, `-`, `*`, `/`, `**`, `=`, `+=`, `++`, `-=`, `*=`, `/=`, `**=`, `==`, `===`, `!=`, `!==`, `>`, `>=`, `<`, `<=`, `?`, `:`, `&&`, `||`, `??`, `&`, `|`, `^`, `~`, `>>`, `<<`, `&=`, `|=`, and `^=`
79
+ * `operator` - the JavaScript operators `+`, `-`, `*`, `/`, `**`, `=`, `+=`, `++`, `-=`, `*=`, `/=`, `**=`, `==`, `===`, `!=`, `!==`, `>`, `>=`, `<`, `<=`, `?`, `:`, `&&`, `||`, `??`, `&`, `|`, `^`, `~`, `>>`, `<<`, `&=`, `|=`, and `^=`.
80
80
 
81
- * `object-colon` - the colons (`:`) separating keys from values in JavaScript objects
82
- * `property-accessor` - the property access operator or dot operator (`.`), for example `Array.from`
83
- * `spread-operator` - the JavaScript spread operator (`...`)
84
- * `global-object` - global objects and functions: `process`, `require`, `console`, `window`, `global`, `globalThis`, `isNaN`
85
- * `undefined` - the `undefined` value
86
- * `null` - the `null` object
87
- * `boolean` - booleans `true` and `false`
88
- * `not-a-number` - the special numeric value `NaN` that represents an undefined or unrepresentable number, for example `0 / 0`
81
+ * `object-colon` - the colons (`:`) separating keys from values in JavaScript objects.
82
+ * `property-accessor` - the property access operator or dot operator (`.`), for example `Array.from`.
83
+ * `spread-operator` - the JavaScript spread operator (`...`).
84
+ * `global-object` - global objects and functions: `process`, `require`, `console`, `window`, `global`, `globalThis`, `isNaN`.
85
+ * `undefined` - the `undefined` value.
86
+ * `null` - the `null` object.
87
+ * `boolean` - booleans `true` and `false`.
88
+ * `not-a-number` - the special numeric value `NaN` that represents an undefined or unrepresentable number, for example `0 / 0`.
89
+
90
+ ## Example
91
+ Please find a runnable example in the `example` directory. You can run the example with a static web server such as [Static Web Server](https://static-web-server.net/).
92
+ ```sh
93
+ static-web-server --port=8080 --root=./example -e=false
94
+ ```
95
+
96
+ ## License
97
+ ArcheHTML is distributed under the [CFOSS License](https://cloutsworld.com/en-us/legal/license/cfoss).
98
+
99
+ ## Support
100
+ * minimum Node.js version: 16
101
+ * minimum Chrome version: 63
102
+ * minimum Firefox version: 57
103
+ * minimum Edge version: 79
104
+ * minimum Safari version: 11.1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "arche-highlight",
3
- "version": "0.5.5",
3
+ "version": "0.6.0",
4
4
  "description": "Syntax highlighting for vanilla microfrontends",
5
5
  "author": "Richard Tong",
6
6
  "license": "CFOSS",