jade-bot - npm Package Compare versions

Comparing version 1.1.4 to 2.0.0

package.json

 {
   "name": "jade-bot",
-  "version": "1.1.4",
-  "description": "twitter bot",
-  "main": "bot.js",
+  "version": "2.0.0",
+  "description": "A Twitter retweet and favorite bot",
+  "main": "index.js",
   "scripts": {
-    "start": "node bot.js",
-    "test": "mocha"
+    "start": "node index.js",
+    "compile": "babel src/ -d lib/",
+    "flow": "node_modules/flow-bin/vendor/flow",
+    "test": "yarn run compile && node_modules/snyk/cli/index.js test && node test.js",
+    "protect": "node_modules/snyk/cli/index.js --yes",
+    "prepare": "yarn run protect"
   },
-  "author": "Jade Thornton",
+  "author": "Jade M Thornton",
   "license": "MIT",
   "dependencies": {
+    "dotenv": "^4.0.0",
+    "flow-bin": "^0.58.0",
+    "snyk": "^1.47.0",
     "twit": "^2.2.5",
@@ -17,8 +24,6 @@ "unique-random-array": "^1.0.0"
   "devDependencies": {
-    "mocha": "^3.2.0"
+    "babel-cli": "^6.26.0",
+    "babel-preset-flow": "^6.23.0"
   },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/Raindeer44/jade-bot.git"
-  },
+  "repository": "git+https://github.com/Raindeer44/jade-bot.git",
   "bugs": {
@@ -25,0 +30,0 @@ "url": "https://github.com/Raindeer44/jade-bot/issues"

README.md

@@ -1,9 +0,59 @@
-# Jade Bot
+# Jade-Bot
 
-Jade-bot is a Node.js Twitter bot which automates the process of Twittering for [@jmthorntonwhat](https://twitter.com/jmthorntonwhat). It basically favorites and retweets for me, among other small tasks.
+[![Build Status](https://travis-ci.org/Raindeer44/jade-bot.svg?branch=master)](https://travis-ci.org/Raindeer44/jade-bot) [![Known Vulnerabilities](https://snyk.io/test/github/raindeer44/jade-bot/badge.svg)](https://snyk.io/test/github/raindeer44/jade-bot) [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/Raindeer44/jade-bot/master/LICENSE)
 
-This doesn't mean there's never a Human behind my Twitter account, just some of my account.
+Jade-bot is a Node-based Twitter bot which automates the process of Twittering for [@jmthorntonwhat](https://twitter.com/jmthorntonwhat).
 
-This Jade bot was created with the help of [Spences10](https://github.com/spences10)'s Node.js [Twitter bot bootstrap](https://github.com/spences10/twitter-bot-bootstrap), and with inspiration from [@amanhimself](https://twitter.com/amanhimself).
+This doesn't mean there's never a human behind my Twitter account, just some of my account.
 
-Copyright (c) 2017 Jade Thornton
+## Installation
+
+### Set up the bot
+
+```bash
+$ git clone <https://github.com/Raindeer44/jade-bot.git>
+$ cd jade-bot/
+$ yarn
+$ yarn test
+```
+
+### Get API keys
+
+Set up an application on the Twitter account you want to use: [https://apps.twitter.com/app/new](https://apps.twitter.com/app/new). Add to the `.env` file:
+
+* Consumer Key (API Key)
+* Consumer Secret (API Secret)
+* Access Token
+* Access Token Secret
+
+`.env` also needs the rate at which you want the bot to retweet (in minutes).
+
+For example, `.env` might look something like
+
+```
+CONSUMER_KEY=Fw***********P9
+CONSUMER_SECRET=TD************Cq
+ACCESS_TOKEN=31**************UC
+ACCESS_TOKEN_SECRET=r0************S2
+
+TWITTER_RETWEET_RATE=30
+```
+
+### Start the bot
+
+That's all the set up! Now just run
+
+```bash
+$ yarn start
+```
+
+For continuous usage, either run on a server (if you happen to have one lying around) or deploy to Heroku, a serverless architecture or a similar service.
+
+## Contributing
+Please fork this repository and contribute back using pull requests.
+
+Any contributions, large or small, major features, bug fixes and integration tests are welcomed and appreciated but will be thoroughly reviewed and discussed.
+
+### Links
+
+This bot was created with the help of [Spences10](https://github.com/spences10)'s Node.js [Twitter bot bootstrap](https://github.com/spences10/twitter-bot-bootstrap), and with inspiration from [@amanhimself](https://twitter.com/amanhimself).

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 6 instances in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

95864

increased by1001.38%

Number of package files

24

increased by118.18%

Lines of code

237

increased by28.8%

Number of lines in readme file

60

increased by500%

Worsened metrics

Dependency count

5

increased by150%

Dev dependency count

2

increased by100%

Number of low supply chain risk alerts

13

increased byInfinity%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addeddotenv@^4.0.0

• + Addedflow-bin@^0.58.0

• + Addedsnyk@^1.47.0

• + Added@sentry-internal/tracing@7.120.3(transitive)

• + Added@sentry/core@7.120.3(transitive)

• + Added@sentry/integrations@7.120.3(transitive)

• + Added@sentry/node@7.120.3(transitive)

• + Added@sentry/types@7.120.3(transitive)

• + Added@sentry/utils@7.120.3(transitive)

• + Addedboolean@3.2.0(transitive)

• + Addeddefine-data-property@1.1.4(transitive)

• + Addeddefine-properties@1.2.1(transitive)

• + Addeddetect-node@2.1.0(transitive)

• + Addeddotenv@4.0.0(transitive)

• + Addedes-define-property@1.0.1(transitive)

• + Addedes-errors@1.3.0(transitive)

• + Addedes6-error@4.1.1(transitive)

• + Addedescape-string-regexp@4.0.0(transitive)

• + Addedflow-bin@0.58.0(transitive)

• + Addedglobal-agent@3.0.0(transitive)

• + Addedglobalthis@1.0.4(transitive)

• + Addedgopd@1.2.0(transitive)

• + Addedhas-property-descriptors@1.0.2(transitive)

• + Addedimmediate@3.0.6(transitive)

• + Addedlie@3.1.1(transitive)

• + Addedlocalforage@1.10.0(transitive)

• + Addedmatcher@3.0.0(transitive)

• + Addedobject-keys@1.1.1(transitive)

• + Addedroarr@2.15.4(transitive)

• + Addedsemver@7.6.3(transitive)

• + Addedsemver-compare@1.0.0(transitive)

• + Addedserialize-error@7.0.1(transitive)

• + Addedsnyk@1.1295.2(transitive)

• + Addedsprintf-js@1.1.3(transitive)

• + Addedtype-fest@0.13.1(transitive)