Added Prettier, ESLint & updated dependencies (#130)

* Updated dependencies, added ESLint & Prettier
* Added empty lines at end of files
* Removed no-longer-needed comment
* Added type checking to linting
* Added Docusaurus types to lock file
* Update docusaurus.config.ts

Co-authored-by: José Julián Espina <[email protected]>

Author: Razican

.eslintignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.eslintrc.cjs

@@ -0,0 +1,20 @@
+module.exports = {
+  root: true,
+  extends: [
+    "eslint:recommended",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:@docusaurus/recommended",
+    "prettier",
+  ],
+  parser: "@typescript-eslint/parser",
+  plugins: ["@typescript-eslint"],
+  parserOptions: {
+    sourceType: "module",
+    ecmaVersion: 2020,
+  },
+  env: {
+    browser: true,
+    es2017: true,
+    node: true,
+  },
+};

.prettierignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

babel.config.js

@@ -1,3 +1,3 @@
 module.exports = {
-  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+  presets: [require.resolve("@docusaurus/core/lib/babel/preset")],
 };

blog/2021-01-14-boa-release-11/index.mdx

@@ -33,7 +33,10 @@ Previously many tests failed to run as the test-runner was still being worked on
 
 For live tracking of conformance tests you can check [here](https://boa-dev.github.io/boa/test262/). Below is a snapshot of the previous version and today.
 
-<div className="row" style={{ display: "flex", justifyContent: "space-around" }}>
+<div
+  className="row"
+  style={{ display: "flex", justifyContent: "space-around" }}
+>
   <section className="col-md-4" id="version-latest">
     <div className="card">
       <div className="card-body" style={{ padding: "10px" }}>

blog/2021-09-30-boa-release-13.md

@@ -31,7 +31,7 @@ This release brings support for the relative indexing method [String.prototype.a
 const sentence = "The quick brown fox jumps over the lazy dog.";
 let index = 5;
 console.log(
-  `Using an index of ${index} the character returned is ${sentence.at(index)}`
+  `Using an index of ${index} the character returned is ${sentence.at(index)}`,
 );
 // expected output: "Using an index of 5 the character returned is u"
 ```

blog/2024-02-29-boa-release-18/index.md

@@ -7,8 +7,9 @@ author: Boa Developers
 
 ## Summary
 
-Boa v0.18 is now available! After 7 months of development we are very happy to present you the latest release of the Boa JavaScript engine. Boa makes it easy to
-embed a JS engine in your projects, and you can even use it from WebAssembly. See the [about](/about) page for more info.
+Boa v0.18 is now available! After 7 months of development we are very happy to present you the latest release of the Boa
+JavaScript engine. Boa makes it easy to embed a JS engine in your projects, and you can even use it from WebAssembly.
+See the [about](/about) page for more info.
 
 In this release, our conformance has grown from 78.74% to 84.64% in the official ECMAScript Test Suite (Test262). While
 this might look as a small increase, we now pass **6,079** more tests than in the previous version. In any case, the big
@@ -35,12 +36,14 @@ Furthermore, we now have a new domain for Boa, [boajs.dev][boajs].
 
 ### We're on [test262.fyi](https://test262.fyi/)!
 
-Thanks to the amazing work of [CanadaHonk](https://twitter.com/CanadaHonk), Boa is now listed on [test262.fyi](https://test262.fyi/). This is a great achievement for us and we are very proud to be listed alongside other major JavaScript engines. It should be much easier for users to compare Boa's conformance tests with other engines.
+Thanks to the amazing work of [CanadaHonk](https://twitter.com/CanadaHonk), Boa is now listed on
+[test262.fyi](https://test262.fyi/). This is a great achievement for us and we are very proud to be listed alongside
+other major JavaScript engines. It should be much easier for users to compare Boa's conformance tests with other engines.
 
 <div class="conformance_set">
 
-![conformance](./conformance_dark.png)
-![conformance_time](./conformance_time_dark.png)
+<!-- ![conformance](./conformance_dark.png)
+![conformance_time](./conformance_time_dark.png) -->
 
 </div>
 

docs/architecture/_category_.json

@@ -4,4 +4,4 @@
   "link": {
     "type": "generated-index"
   }
-}
+}

docs/architecture/overview.md

@@ -1,6 +1,7 @@
 ---
 sidebar_position: 1
 ---
+
 # Overview
 
 Boa is a compiled and interpretted ECMAScript/JS engine.

docs/contributing/_category_.json

@@ -4,4 +4,4 @@
   "link": {
     "type": "generated-index"
   }
-}
+}

docs/debugging/_category_.json

@@ -4,4 +4,4 @@
   "link": {
     "type": "generated-index"
   }
-}
+}

docs/debugging/debug_intro.md

@@ -6,4 +6,4 @@ sidebar_position: 1
 
 There are various tools and methods provided to assist with debugging Boa.
 
-We are always looking for new methods of debugging. If there is one that you think would be useful, please feel free to submit an issue and/or pull request.
+We are always looking for new methods of debugging. If there is one that you think would be useful, please feel free to submit an issue and/or pull request.

docs/debugging/debug_object.md

@@ -20,13 +20,13 @@ it accessible to Boa when the source code is executed.
 
 The debug object currently has the below modules implemented:
 
-* [`gc`](./debug_object#boagc)
-* [`function`](./debug_object#boafunction)
-* [`object`](./debug_object#boaobject)
-* [`optimizer`](./debug_object#boaoptimizer)
-* [`realm`](./debug_object#boarealm)
-* [`shape`](./debug_object#boashape)
-* [`limits`](./debug_object#boalimits)
+- [`gc`](./debug_object#boagc)
+- [`function`](./debug_object#boafunction)
+- [`object`](./debug_object#boaobject)
+- [`optimizer`](./debug_object#boaoptimizer)
+- [`realm`](./debug_object#boarealm)
+- [`shape`](./debug_object#boashape)
+- [`limits`](./debug_object#boalimits)
 
 If there is any functionality currently missing that you think may be helpful, please feel free to submit an issue or Pull Request!
 

docs/debugging/debug_other.md

@@ -1,6 +1,7 @@
 ---
 sidebar_position: 6
 ---
+
 # Debuggers
 
 There are also other methods of debugging listed below.
@@ -20,4 +21,4 @@ rust-lldb ./target/debug/boa [arguments]
 ```
 
 [remote_containers]: https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers
-[blog_debugging]: https://jason-williams.co.uk/debugging-rust-in-vscode
+[blog_debugging]: https://jason-williams.co.uk/debugging-rust-in-vscode

docs/debugging/debug_trace.md

@@ -105,4 +105,4 @@ main:
 00014:  InitGLexical "b"                # 2
 00019:  Pop                             #
 00020:  GetGName "dis"                  # dis
-```
+```

docs/intro.md

@@ -10,14 +10,14 @@ Boa also exists to serve as a Rust implementation of the EcmaScript specificatio
 
 Boa currently publishes the following crates:
 
-* boa_ast - Boa’s ECMAScript Abstract Syntax Tree.
-* boa_engine - Boa’s implementation of ECMAScript builtin objects and execution.
-* boa_gc - Boa’s garbage collector.
-* boa_interner - Boa’s string interner.
-* boa_parser - Boa’s lexer and parser.
-* boa_profiler - Boa’s code profiler.
-* boa_icu_provider - Boa’s ICU4X data provider.
-* boa_runtime - Boa’s WebAPI features.
+- boa_ast - Boa’s ECMAScript Abstract Syntax Tree.
+- boa_engine - Boa’s implementation of ECMAScript builtin objects and execution.
+- boa_gc - Boa’s garbage collector.
+- boa_interner - Boa’s string interner.
+- boa_parser - Boa’s lexer and parser.
+- boa_profiler - Boa’s code profiler.
+- boa_icu_provider - Boa’s ICU4X data provider.
+- boa_runtime - Boa’s WebAPI features.
 
 The goal of the following documentation is to provide a reference guide for the current design of Boa and it's most current features.
 

docs/optimizations/_category_.json

@@ -4,4 +4,4 @@
   "link": {
     "type": "generated-index"
   }
-}
+}

docs/profiling.md

@@ -37,29 +37,29 @@ This is the same as above except instead of calling `$ crox my_trace` you call `
 
 ```md
 +---------------------------------------+-----------+-----------------+----------+------------+
-| Item                                  | Self time | % of total time | Time     | Item count |
+| Item | Self time | % of total time | Time | Item count |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| From<Object>                          | 1.04ms    | 14.776          | 1.04ms   | 146        |
+| From<Object> | 1.04ms | 14.776 | 1.04ms | 146 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| new_object                            | 356.50µs  | 5.082           | 533.50µs | 18         |
+| new_object | 356.50µs | 5.082 | 533.50µs | 18 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| create_instrinsics                    | 263.50µs  | 3.756           | 6.38ms   | 1          |
+| create_instrinsics | 263.50µs | 3.756 | 6.38ms | 1 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| make_builtin_fn: toString             | 218.50µs  | 3.114           | 290.50µs | 12         |
+| make_builtin_fn: toString | 218.50µs | 3.114 | 290.50µs | 12 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| Value::get_field                      | 178.60µs  | 2.546           | 340.20µs | 60         |
+| Value::get_field | 178.60µs | 2.546 | 340.20µs | 60 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| Value::get_property                   | 161.60µs  | 2.303           | 161.60µs | 60         |
+| Value::get_property | 161.60µs | 2.303 | 161.60µs | 60 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| lex                                   | 135.60µs  | 1.933           | 135.60µs | 1          |
+| lex | 135.60µs | 1.933 | 135.60µs | 1 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| math:create                           | 125.40µs  | 1.787           | 1.11ms   | 1          |
+| math:create | 125.40µs | 1.787 | 1.11ms | 1 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| Value::set_field                      | 100.20µs  | 1.428           | 262.80µs | 8          |
+| Value::set_field | 100.20µs | 1.428 | 262.80µs | 8 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| function::builtin                     | 82.40µs   | 1.175           | 82.40µs  | 146        |
+| function::builtin | 82.40µs | 1.175 | 82.40µs | 146 |
 +---------------------------------------+-----------+-----------------+----------+------------+
-| String                                | 81.60µs   | 1.163           | 961.60µs | 1          |
+| String | 81.60µs | 1.163 | 961.60µs | 1 |
 +---------------------------------------+-----------+-----------------+----------+------------+
 ```