felipesousa / wunderlist-api Goto Github PK

Acceptance criteria:

• Add support to Jest
• Add script to run and collect coverage;

Acceptance Criteria:

• section: the project
• #21
• section: how to use
• section: features/endpoints;
• section: contribute
• section: credits

Acceptance criteria:

• create auth class
• define request base headers
• create tests cases

More details here;

Acceptance criteria:

• add package in github packages.

I'm afraid the ES6 modules are breaking the npm-module in node v8.9.3

➜  node --version
v8.9.3
➜  node index.js                                       
./node_modules/wunderlist-api/build/index.js:524
export default Wunderlist;
^^^^^^

SyntaxError: Unexpected token export

Even with the experimental flag on, it doesn't work:

➜  node --experimental-modules index.js
(node:94262) ExperimentalWarning: The ESM module loader is experimental.
index.js:11
import WunderlistAPI from 'wunderlist-api';
^^^^^^

SyntaxError: Unexpected token import
    at createScript (vm.js:80:10)

And if you'll try babel with prefixes (2015 or 2016) it doesn't work as well.

➜ npm start
> babel-node index.js --presets es2015,stage-2

./node_modules/wunderlist-api/build/index.js:524
export default Wunderlist;
^^^^^^

SyntaxError: Unexpected token export

• code coverage
• build process
• releases/publish
• docs in github pages

Acceptance criteria:

• get a template docs and implement
• add action to automate the process to update the docs
• create the documentation page and publish in some static server;

hi guys. thanks for publishing your project! :)

when trying to authenticate with my clientID/accessToken I get an error saying:

body: '{"error":{"type":"server_error","translation_key":"api_error_unknown","message":"An unknown server error occurred","authentication":["missing"]}}' }

here's my code:

"use strict";

const Wunderlist = require("wunderlist-api");

const wunderlist = new Wunderlist({
  clientID: "xxx",
  accessToken: "xxx"
});

// authentication
wunderlist
  .user()
  .then(response => {
    // response
    console.log(response);
  })
  .catch(error => {
    // handle error
  });

what am i doing wrong?

Setup RollupJS with TypeScript;

More details about RollupJS here.

Dependencies tasks:
[ ] #5

Acceptance Criteria:

• Automated pipelines in GitHub actions;
• Publish Docs on github pages
• run tests, build and publish the project version each time when merging with master

more details here.

Add support to typescript language. - more details here.

More details here: https://coveralls.io/

acceptance criteria:

• add ISSUE REPORT template
• add PULL REQUEST template
• add CONTRIBUTING template

more details here.

more details here

Acceptance criteria:

• Add typedoc and setup npm scripts to run each push
• Add a github action to publish the docs result to github pages

Add prettier support and automation;

more details here.

TSLint support with Prettier (https://palantir.github.io/tslint/)

When the script build is executed the prompt return a dependecies error:

> tsc -p tsconfig.json && rollup -c rollup.config.js

node_modules/@types/jest/index.d.ts:484:51 - error TS2307: Cannot find module 'jest-diff'.

484             diff(a: any, b: any, options?: import("jest-diff").DiffOptions): string | null;
                                                      ~~~~~~~~~~~

node_modules/@types/jest/index.d.ts:538:44 - error TS2307: Cannot find module 'pretty-format'.

538     type SnapshotSerializerPlugin = import('pretty-format').Plugin;
                                               ~~~~~~~~~~~~~~~

Describe the solution you'd like

• Define the rules to each action (deploy, build, tests, releases, branchs, actions)

Describe alternatives you've considered
Use npm publish and plugins to run the actions