chore: Update project files.

CHANGELOG.md

@@ -1,7 +1,15 @@
+## 0.1.2
+
+- Bumped dependency versions in `package.json`, added an explicit import for `ts-node`.
+- Bumped the year in the `LICENCE` copyright notice to 2024.
+- Added a contributing guide in `CONTRIBUTING.md`.
+- Added `jsr.json` for publishing to JSR.
+- Updated `biome.json`.
+
 ## 0.1.1
 
-- Switch from `rome` to `biome`.
-- Add missing exports.
+- Switched from `rome` to `biome`.
+- Added missing exports.
 
 ## 0.1.0
 

CONTRIBUTING.md

@@ -0,0 +1,38 @@
+## Contribute to `dexonline-scraper`
+
+> Before you start, make sure you have the latest version of Node.js and NPM installed on your system.
+
+To start contributing, first create your own working copy of `dexonline-scraper` that you can freely make changes to. You can do this by going to the [dexonline-scraper](https://github.com/vxern/dexonline-scraper) and forking the repository.
+
+Once you have forked the repository, `git clone` it to download it locally:
+```
+git clone https://github.com/your-username-here/dexonline-scraper.git
+```
+
+Once you have your local copy of `dexonline-scraper` ready, run the following command to download all the necessary dependencies:
+```
+npm run setup
+```
+
+Afterwards, just to ensure the setup ran smoothly and the repository is ready to go, run the test suite:
+```
+npm run test
+```
+
+> Optional: If you are contributing to the original project, feel free to skip this step.
+>
+> If you intend to publish your fork of `dexonline-scraper`, there is an additional step of installing JSR as a global dependency:
+> ```
+> npm install --global jsr
+> ```
+
+And just like that, you're ready to develop!
+
+Once you've made your changes, create a pull request to merge them into `dexonline-scraper`, but before you do that, make sure of the following:
+- Run the formatter.
+  - Ideally, you should have your IDE set up in such a way where it would re-format the file on every change. However, just to make sure it complies with Biome and the linter ruleset in `biome.json`, run `npm run format` before you commit your changes.
+- Write tests for your changes, using the existing tests as a guideline for how they should look.
+  - If you can't write a test and the reason for that isn't immediately obvious, state why they couldn't be written.
+- Keep your pull requests small, ideally up to 200 lines of code. This makes it easier for potential reviewers of your PR to not get discouraged reading a massive PR with tons of changes, and increases your chances of having your PR merged quickly.
+
+Happy contributing!

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Dorian "vxern" Oszczęda
+Copyright (c) 2024 Dorian "vxern" Oszczęda
 
 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

biome.json

@@ -3,21 +3,22 @@
 		"enabled": true,
 		"rules": {
       "all": true,
-      "suspicious": {
-        "noEmptyInterface": "off"
-      },
       "nursery": {
         "useImportRestrictions": "off"
       },
       "style": {
-        "useNamingConvention": "off"
+        "useNamingConvention": "off",
+        "noNonNullAssertion": "off"
+      },
+      "suspicious": {
+        "noEmptyInterface": "off"
       }
 		}
 	},
   "formatter": {
     "enabled": true,
     "formatWithErrors": true,
-    "indentSize": 2,
+    "indentWidth": 2,
     "indentStyle": "tab",
     "lineWidth": 120
   }

jsr.json

@@ -0,0 +1,5 @@
+{
+  "name": "@vxern/dexonline-scraper",
+  "version": "0.1.2",
+  "exports": "./src/index.ts"
+}