arcath / rollup-plugin-screeps Goto Github PK

Rollup Plugin for publishing your code to a Screeps server

JavaScript 56.82% TypeScript 43.18%

rollup-plugin-screeps's Introduction

Rollup Screeps Plugin

Install

npm install --save-dev rollup-plugin-screeps

Usage

In rollup.config.js

import screeps from "rollup-plugin-screeps";

...

export default {
  ...
  sourcemap: true, // If set to true your source maps will be made screeps friendly and uploaded

  plugins: [
    ...
    screeps({configFile: "./screeps.json"})
  ]
}

Config File

rollup-plugin-screeps needs your screeps username/password and the server to upload to.

{
  "email": "[email protected]",
  "password": "pass",
  "protocol": "https",
  "hostname": "screeps.com",
  "port": 443,
  "path": "/",
  "branch": "auto"
}

If branch is set to "auto" rollup-plugin-screeps will use your current git branch as the name of the branch on screeps, if you set it to anything else that string will be used as the name of the branch.

rollup-plugin-screeps's People

Contributors

Stargazers

Watchers

Forkers

ryan-bunker brisberg brooksvb pyrodogg duckymirror connorzg jsejcksn walze spraxdev aclarke822 futureastrominer tsrberry shup1 tannerallison shanemadden screepers inticus74

rollup-plugin-screeps's Issues

"module.export =" - prefix is not prepended correctly to sourcemap

Since working with sourcemaps I've found that the sourcemap needs to be uploaded with the module.export prefix to work.
This looks like it's handled in "generateSourceMaps", however, while debugging I've found that it's never ran, nor affects the output.

Tl:dr; It looks like the toString wrapper doesnt work anymore.

Implement token-based auth system

Screeps has recently introduced a token-based auth system, and the old authentication system will be deprecated by 01 February 2018. We should start look into implementing the new auth system and deprecate the old one.

Cannot install on node 10

Due to outdated dependencies, this currently doesn't install on node 10. Updating screeps-api to a more recent version will allow it to install again. (Related issue: screepers/node-screeps-api#36)

npm audit, Severity: high, git-rev-sync 1.3.0 - 3.0.1

Just a heads up that npm audit is highlighting a vulnerability due to a dependancy:

shelljs <0.8.5
Severity: high
Improper Privilege Management in shelljs - GHSA-4rq4-32rv-6wp6
No fix available
node_modules/shelljs
git-rev-sync 1.3.0 - 3.0.1
Depends on vulnerable versions of shelljs
node_modules/git-rev-sync
rollup-plugin-screeps *
Depends on vulnerable versions of git-rev-sync
node_modules/rollup-plugin-screeps

Can I use proxy?

How can I config use proxy to upload my code?

DeprecationWarning running `npm run push--pserver` when server is offline

If the server is offline, instead of giving a proper message we receive the following error

(node:9848) UnhandledPromiseRejectionWarning: Error:
    at ScreepsAPI.req (C:\Projects\Screeps\node_modules\screeps-api\dist\ScreepsAPI.js:640:13)
    at processTicksAndRejections (internal/process/task_queues.js:93:5)
(node:9848) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). (rejection id: 2)
(node:9848) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.

I think the following two places needs a .catch maybe more places where the api is used.

rollup-plugin-screeps/src/rollup-plugin-screeps.ts

Lines 114 to 123 in ccee925

 api.raw.user.branches().then((data: any) => { 

 let branches = data.list.map((b: any) => b.branch) 

 if (branches.includes(branch)) { 

 api.code.set(branch, code) 

 } else { 

 api.raw.user.cloneBranch('', branch, code) 

 } 

 }) 

 }

rollup-plugin-screeps/src/rollup-plugin-screeps.ts

Lines 104 to 106 in ccee925

 api.auth().then(() => { 

 runUpload(api, branch!, code) 

 })

Update to newer Rollup hooks

Running under Rollup 1.27.5:

(!) The "ongenerate" hook used by plugin screeps is deprecated. The "generateBundle" hook should be used instead.
(!) The "onwrite" hook used by plugin screeps is deprecated. The "generateBundle/writeBundle" hook should be used instead.

	api.raw.user.branches().then((data: any) => {
	let branches = data.list.map((b: any) => b.branch)

	if (branches.includes(branch)) {
	api.code.set(branch, code)
	} else {
	api.raw.user.cloneBranch('', branch, code)
	}
	})
	}