Closed nelsonic closed 7 years ago
I should have some time in the next few days to do this, if someone hasn't gotten to it already.
--fix
What's the recommended version of node for this project? It may be helpful to add that into the package.json
.
I've been getting errors when running npm run test
for example, but these don't occur if I just run the commands directly from the shell. Wondering if it might be an npm/node version issue?
Again, these work just fine without routing them through npm-scripts.
npm run test
➜ sendemail git:(goodparts-refactor) ✗ npm run test
> sendemail@3.0.0 test /Users/dm/Documents/dev/dwyl/sendemail
> istanbul cover ./node_modules/tape/bin/tape ./test/*.js
=============================================================================
Writing coverage object [/Users/dm/Documents/dev/dwyl/sendemail/coverage/coverage.json]
Writing coverage reports at [/Users/dm/Documents/dev/dwyl/sendemail/coverage]
=============================================================================
=============================== Coverage summary ===============================
Statements : 43.33% ( 13/30 )
Branches : 10% ( 1/10 )
Functions : 25% ( 1/4 )
Lines : 44.83% ( 13/29 )
================================================================================
/Users/dm/Documents/dev/dwyl/sendemail/lib/index.js:9
__cov_0bPW1yJMw2v7xpvKYS1dnw.s['1']++;var AWS=require('aws-sdk');__cov_0bPW1yJMw2v7xpvKYS1dnw.s['2']++;AWS.config.region=process.env.AWS_REGION;__cov_0bPW1yJMw2v7xpvKYS1dnw.s['3']++;var ses=new AWS.SES();__cov_0bPW1yJMw2v7xpvKYS1dnw.s['4']++;var path=require('path');__cov_0bPW1yJMw2v7xpvKYS1dnw.s['5']++;var fs=require('fs');__cov_0bPW1yJMw2v7xpvKYS1dnw.s['6']++;var Handlebars=require('handlebars');__cov_0bPW1yJMw2v7xpvKYS1dnw.s['7']++;var COMPILED_TEMPLATES={};function set_template_directory(dir){__cov_0bPW1yJMw2v7xpvKYS1dnw.f['1']++;__cov_0bPW1yJMw2v7xpvKYS1dnw.s['9']++;if(!dir){__cov_0bPW1yJMw2v7xpvKYS1dnw.b['1'][0]++;__cov_0bPW1yJMw2v7xpvKYS1dnw.s['10']++;throw'Please Set a Template Directory';}else{__cov_0bPW1yJMw2v7xpvKYS1dnw.b['1'][1]++;}__cov_0bPW1yJMw2v7xpvKYS1dnw.s['11']++;var files=fs.readdirSync(dir);__cov_0bPW1yJMw2v7xpvKYS1dnw.s['12']++;process.env.TEMPLATE_DIRECTORY=dir;}__cov_0bPW1yJMw2v7xpvKYS1dnw.s['13']++;set_template_directory(process.
Please Set a Template Directory
npm ERR! Darwin 16.3.0
npm ERR! argv "/Users/dm/.nvm/versions/node/v7.4.0/bin/node" "/Users/dm/.nvm/versions/node/v7.4.0/bin/npm" "run" "test"
npm ERR! node v7.4.0
npm ERR! npm v4.0.5
npm ERR! code ELIFECYCLE
npm ERR! sendemail@3.0.0 test: `istanbul cover ./node_modules/tape/bin/tape ./test/*.js`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the sendemail@3.0.0 test script 'istanbul cover ./node_modules/tape/bin/tape ./test/*.js'.
npm ERR! Make sure you have the latest version of node.js and npm installed.
npm ERR! If you do, this is most likely a problem with the sendemail package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR! istanbul cover ./node_modules/tape/bin/tape ./test/*.js
npm ERR! You can get information on how to open an issue for this project with:
npm ERR! npm bugs sendemail
npm ERR! Or if that isn't available, you can get their info via:
npm ERR! npm owner ls sendemail
npm ERR! There is likely additional logging output above.
npm ERR! Please include the following file with any support request:
npm ERR! /Users/dm/Documents/dev/dwyl/sendemail/npm-debug.log
npm run lint
npm ERR! Darwin 16.3.0
npm ERR! argv "/Users/dm/.nvm/versions/node/v7.4.0/bin/node" "/Users/dm/.nvm/versions/node/v7.4.0/bin/npm" "run" "lint"
npm ERR! node v7.4.0
npm ERR! npm v4.0.5
npm ERR! code ELIFECYCLE
npm ERR! sendemail@3.0.0 lint: `goodparts lib/`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the sendemail@3.0.0 lint script 'goodparts lib/'.
@newswim looks like the lint --fix
was a "too aggressive"... thanks for investigating this! 👍
Funny enough, it works when I re-installed node_modules
using Yarn. I know we're avoiding, but this seems to be specific to npm version.
(this is the main reason i've started using Yarn, it's weird ability to solve inexplicables)
@newswim which module is causing issues?
Failed at the sendemail@3.0.0 lint script 'goodparts lib/'.
that's part of the output from npm run lint
more not-really-helpful npm output:
$ npm run lint
npm ERR! Darwin 16.3.0
npm ERR! argv "/Users/dm/.nvm/versions/node/v7.4.0/bin/node" "/Users/dm/.nvm/versions/node/v7.4.0/bin/npm" "run" "test"
npm ERR! node v7.4.0
npm ERR! npm v4.0.5
npm ERR! code ELIFECYCLE
npm ERR! sendemail@3.0.0 test: `istanbul cover ./node_modules/tape/bin/tape ./test/*.js`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the sendemail@3.0.0 test script 'istanbul cover ./node_modules/tape/bin/tape ./test/*.js'.
Ok, that won't be an NPM issue though ...
try running the tests without istanbul cover
Hope you like console dumps...
➜ sendemail git:(goodparts-refactor) ✗ npm run quick
> sendemail@3.0.0 quick /Users/dm/Documents/dev/dwyl/sendemail
> ./node_modules/tape/bin/tape ./test/*.js
/Users/dm/Documents/dev/dwyl/sendemail/lib/index.js:16
throw 'Please Set a Template Directory';
^
Please Set a Template Directory
npm ERR! Darwin 16.3.0
npm ERR! argv "/Users/dm/.nvm/versions/node/v7.4.0/bin/node" "/Users/dm/.nvm/versions/node/v7.4.0/bin/npm" "run" "quick"
npm ERR! node v7.4.0
npm ERR! npm v4.0.5
npm ERR! code ELIFECYCLE
npm ERR! sendemail@3.0.0 quick: `./node_modules/tape/bin/tape ./test/*.js`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the sendemail@3.0.0 quick script './node_modules/tape/bin/tape ./test/*.js'.
Do i need to throw that Template Directory var into .env
?
well, I have it working with Yarn for now and am using nodemon
for 💻 'ing ---- gonna start the cleanup!
There are some issues with the tests, but I think that's out of the scope of this PR. Happy to investigate further, but I'm going to sleep now! 🌃
Great Work @newswim! sleep well! 😴
done
🎉
at present the code in this module works as expected. but... it does not follow our "style guide": https://github.com/dwyl/goodparts ideally, all our projects should follow this guide to ensure we have consistency across all our JS.
If anyone has the time/patience to re-factor the code in
/lib
to conform togoodparts
please comment on this issue to show your interest.Note
: "Refactoring" is when you don't change any existing tests.only update
the code in/lib
files to use a different code style.Note2
: If you haven't already done so, please read and :star: the "Contributing Guide": https://github.com/dwyl/contributing to ensure that our "steps" are followed and someone can read your Pull Request without any delays. 👍The task(s) are:
goodparts-refactor
npm install goodparts --savedev
scripts
section ofpackage.json
npm run lint
That should "fix" a few of the "basic" code style issues, but it will not address any "major" ones.
npm test
goodparts
(ESLint) is reporting...nodemon
each time the file is updated.goodparts
have been resolved and the code conforms to the styleguide, commit your changes referencing this issue in your commit message.README.md
git commit -m 'adds goodparts repo badge see: https://github.com/dwyl/repo-badges#goodparts-javascript-code-style-'