Typescript Additions

.eslintrc.json

@@ -0,0 +1,57 @@
+{
+  "root": true,
+  "env": {
+    "node": true,
+    "es2022": true
+  },
+  "extends": [
+    "airbnb-base"
+  ],
+  "plugins": [
+    "@typescript-eslint/eslint-plugin"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "sourceType": "script",
+    "ecmaVersion": 2022
+  },
+  "rules": {
+    // This enforces strict checks on .js files, it's not necessary for .ts files
+    // https://www.w3schools.com/js/js_strict.asp
+    "strict": [2, "global"],
+    // Removes () around single parameter arrow functions
+    "arrow-parens": [2, "as-needed"],
+    // This is a personal preference to enforce good code
+    "@typescript-eslint/no-non-null-assertion": "warn",
+    // Enforce max line length of 120
+    "max-len": ["warn", { "code": 120 }],
+    // Allow allow any on objects, require definition of types
+    "@typescript-eslint/no-explicit-any": "warn"
+  },
+  "overrides": [
+    {
+      "files": ["**/*.ts","**/*.tsx","**/*.*.ts,**/*.*.json"],
+      "extends": [
+        "airbnb-base",
+        "airbnb-typescript/base"
+      ],
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "project": "./tsconfig.json"
+      },
+      "rules": {
+        // This enforces strict checks on .js files, it's not necessary for .ts files
+        // https://www.w3schools.com/js/js_strict.asp
+        "strict": [2, "global"],
+        // Removes () around single parameter arrow functions
+        "arrow-parens": [2, "as-needed"],
+        // This is a personal preference to enforce good code
+        "@typescript-eslint/no-non-null-assertion": "warn",
+        // Enforce max line length of 120
+        "max-len": ["warn", { "code": 120 }],
+        // Allow allow any on objects, require definition of types
+        "@typescript-eslint/no-explicit-any": "warn"
+      }
+    }
+  ]
+}

.gitignore

@@ -1,3 +1,5 @@
 env/
 venv/
-*.json
+node_modules/
+output/
+substances*.json

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Noah Saso
+Copyright (c) 2021-2023 Noah Saso, TripSit
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,6 +2,9 @@
 
 Script to merge data from PsychonautWiki API + pages and TripSit factsheets into one standardized format
 
+Now with Typescript!
+
+# Python - Developed by Noah Saso
 ## Installation
 
 1.  Install virtualenv
@@ -23,7 +26,7 @@ Script to merge data from PsychonautWiki API + pages and TripSit factsheets into
 
 ## Usage
 ```
-python scrape.py [-h] [output]
+python ./src/scrape.py [-h] [output]
 
 Scrape PsychonautWiki and TripSit data into unified dataset
 
@@ -34,7 +37,30 @@ optional arguments:
   -h, --help  show this help message and exit
 ```
 
-## Output Schema
+# NodeJS - Developed by Moonbear
+
+The NodeJS version utilizes eslint for linting and prettier for formatting. It also uses typescript for type checking.
+Types have been checked but could be improved!
+
+## Installation
+1.  Install packages
+```
+npm install
+```
+
+## Usage
+```
+npm run start
+```
+This will run the program and output the data to `./output/combinedDb.json`
+
+## Development
+```
+npm run dev
+```
+Nodemon will watch for changes and restart the script when changes are detected, making development easier.
+
+# Output Schema
 
 | Property                  | Type                     | Description                                                                    | Source                                                                                |
 | ------------------------- | ------------------------ | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------- |

nodemon.json

@@ -0,0 +1,5 @@
+{
+  "watch": ["src"],
+  "ext": ".ts",
+  "exec": "ts-node src/scrape.ts"
+}