From 87aaefa49847efd73f1db6105e8abd73152103db Mon Sep 17 00:00:00 2001 From: Levi Thomason Date: Mon, 16 May 2016 21:03:26 -0700 Subject: [PATCH] chore: setup changelog (#443) * chore(changelog): add scripts * docs(release): update release docs * chore(editorconfig): add config * docs(changelog): updated by levithomason --- .editorconfig | 14 ++ CHANGELOG.md | 494 +++++++++++++++++++++++++++++++++++++++++++ RELEASE.md | 25 ++- package.json | 3 +- scripts/changelog.sh | 28 +++ 5 files changed, 554 insertions(+), 10 deletions(-) create mode 100644 .editorconfig create mode 100644 CHANGELOG.md create mode 100644 scripts/changelog.sh diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..a35cd0d --- /dev/null +++ b/.editorconfig @@ -0,0 +1,14 @@ +# editorconfig.org + +root = true + +[*] +charset = utf-8 +end_of_line = lf +indent_size = 2 +indent_style = space +insert_final_newline = true +trim_trailing_whitespace = true + +[*.{md,markdown}] +trim_trailing_whitespace = false diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..4490ceb --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,494 @@ +# Change Log + +## [Unreleased](https://github.com/shelljs/shelljs/tree/HEAD) + +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.7.0...HEAD) + +**Closed issues:** + +- Stdout is empty on Git log command [\#439](https://github.com/shelljs/shelljs/issues/439) +- Cannot read toString of null when using execSync [\#415](https://github.com/shelljs/shelljs/issues/415) +- Adding callback to basic commands [\#102](https://github.com/shelljs/shelljs/issues/102) + +**Merged pull requests:** + +- docs: comment code better to help contributors [\#437](https://github.com/shelljs/shelljs/pull/437) ([nfischer](https://github.com/nfischer)) +- chore\(CI\): update appveyor [\#436](https://github.com/shelljs/shelljs/pull/436) ([nfischer](https://github.com/nfischer)) +- chore: test against node v6 [\#433](https://github.com/shelljs/shelljs/pull/433) ([nfischer](https://github.com/nfischer)) +- chore\(make\): depreciate shelljs/make [\#431](https://github.com/shelljs/shelljs/pull/431) ([ariporad](https://github.com/ariporad)) +- docs: warn that README contains newest features [\#410](https://github.com/shelljs/shelljs/pull/410) ([nfischer](https://github.com/nfischer)) + +## [v0.7.0](https://github.com/shelljs/shelljs/tree/v0.7.0) (2016-04-25) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.6.0...v0.7.0) + +**Closed issues:** + +- exec\('nohup node some.js &'\) [\#426](https://github.com/shelljs/shelljs/issues/426) +- cp copy to symlinked folder [\#414](https://github.com/shelljs/shelljs/issues/414) +- Invalid version number \(0.0.1alpha1\) [\#399](https://github.com/shelljs/shelljs/issues/399) +- shelljs Breaks SemVer for Alpha and Pre-Release Versions [\#390](https://github.com/shelljs/shelljs/issues/390) +- Copy not accepting source end with wildcards \* when using -r on v0.6.0 [\#389](https://github.com/shelljs/shelljs/issues/389) +- Support globbing in `shjs` [\#388](https://github.com/shelljs/shelljs/issues/388) +- Refactor more commands to return ShellString [\#373](https://github.com/shelljs/shelljs/issues/373) +- ln\('-sf', './', '\'\) is not linking the right folder [\#363](https://github.com/shelljs/shelljs/issues/363) +- v0.6.0 - shell.cp\('r', '/foo/\*, '/bar'\) fails with /foo/\* no such file or directory [\#342](https://github.com/shelljs/shelljs/issues/342) +- Add documentup as a webhook [\#327](https://github.com/shelljs/shelljs/issues/327) +- Dir glob breaks when in the middle of path [\#245](https://github.com/shelljs/shelljs/issues/245) +- could you switch off wiki page? [\#233](https://github.com/shelljs/shelljs/issues/233) +- ls globbing does not behave like shell, consider using glob.sync [\#225](https://github.com/shelljs/shelljs/issues/225) +- Cannot run shell.exec\('heroku config:push'\) -- just hangs [\#218](https://github.com/shelljs/shelljs/issues/218) +- `cp` does not overwrite files by default [\#210](https://github.com/shelljs/shelljs/issues/210) +- exec failed to return [\#208](https://github.com/shelljs/shelljs/issues/208) +- CLI Version [\#202](https://github.com/shelljs/shelljs/issues/202) +- Bracket expansion not working [\#176](https://github.com/shelljs/shelljs/issues/176) +- "exec" causes LiveScript interpreter \(lsc\) to hang [\#160](https://github.com/shelljs/shelljs/issues/160) +- Don't modify string prototype [\#159](https://github.com/shelljs/shelljs/issues/159) +- `exec\(...\).to\(file\)` should work [\#154](https://github.com/shelljs/shelljs/issues/154) +- Would like to see more async variants for cp/rm etc [\#144](https://github.com/shelljs/shelljs/issues/144) +- Can't install shelljs locally instead of globally [\#136](https://github.com/shelljs/shelljs/issues/136) +- shelljs and node 0.10.28 [\#125](https://github.com/shelljs/shelljs/issues/125) +- Use case for global installed shelljs [\#123](https://github.com/shelljs/shelljs/issues/123) +- Only get stdout from `exec` [\#92](https://github.com/shelljs/shelljs/issues/92) +- What about other commands? [\#90](https://github.com/shelljs/shelljs/issues/90) +- Flesh out example of exit\(\) [\#73](https://github.com/shelljs/shelljs/issues/73) +- exec doesn't work with qualified paths on windows [\#41](https://github.com/shelljs/shelljs/issues/41) +- exec does not working in mingw bash in windows [\#17](https://github.com/shelljs/shelljs/issues/17) +- Add support for cp -P option [\#413](https://github.com/shelljs/shelljs/issues/413) +- cp -L: Incorrect behavior for symlinks to regular files [\#407](https://github.com/shelljs/shelljs/issues/407) +- Edit the docs to emphasize ShellStrings and Pipes [\#398](https://github.com/shelljs/shelljs/issues/398) +- Error message isn't always printed [\#372](https://github.com/shelljs/shelljs/issues/372) +- Standardize command output [\#356](https://github.com/shelljs/shelljs/issues/356) +- exec\(\) doesn't clean up all temp files [\#353](https://github.com/shelljs/shelljs/issues/353) +- Document that exec\(\) options don't work on early versions of node [\#350](https://github.com/shelljs/shelljs/issues/350) +- Add -f option to set\(\) [\#344](https://github.com/shelljs/shelljs/issues/344) +- Glob commands by default [\#343](https://github.com/shelljs/shelljs/issues/343) +- rm -rf incorrect behaviour [\#332](https://github.com/shelljs/shelljs/issues/332) +- Switch `exec\(\)` to use bash by default [\#281](https://github.com/shelljs/shelljs/issues/281) +- pipe to proc [\#148](https://github.com/shelljs/shelljs/issues/148) +- shell builtin [\#138](https://github.com/shelljs/shelljs/issues/138) +- add timeout option for exec [\#132](https://github.com/shelljs/shelljs/issues/132) +- shelljs cp handling symlinks badly [\#69](https://github.com/shelljs/shelljs/issues/69) + +**Merged pull requests:** + +- chore: add "Team" section to README [\#423](https://github.com/shelljs/shelljs/pull/423) ([nfischer](https://github.com/nfischer)) +- Contributing guidelines [\#422](https://github.com/shelljs/shelljs/pull/422) ([nfischer](https://github.com/nfischer)) +- feat\(glob\): expose config.globOptions. [\#400](https://github.com/shelljs/shelljs/pull/400) ([nfischer](https://github.com/nfischer)) +- Add shelljs as a keyword in package.json [\#393](https://github.com/shelljs/shelljs/pull/393) ([nfischer](https://github.com/nfischer)) +- docs: add link to wiki page [\#392](https://github.com/shelljs/shelljs/pull/392) ([nfischer](https://github.com/nfischer)) +- refactor\(cd\): use process.env.OLDPWD to store previous dir [\#383](https://github.com/shelljs/shelljs/pull/383) ([nfischer](https://github.com/nfischer)) +- chore\(appveyor\): add in node 4 for appveyor [\#381](https://github.com/shelljs/shelljs/pull/381) ([nfischer](https://github.com/nfischer)) +- Add Cash cross-reference [\#375](https://github.com/shelljs/shelljs/pull/375) ([dthree](https://github.com/dthree)) +- Ignore gitattributes from npm package [\#361](https://github.com/shelljs/shelljs/pull/361) ([nfischer](https://github.com/nfischer)) +- Consistently use LF line endings [\#355](https://github.com/shelljs/shelljs/pull/355) ([TimothyGu](https://github.com/TimothyGu)) +- Release v0.7.0 [\#429](https://github.com/shelljs/shelljs/pull/429) ([nfischer](https://github.com/nfischer)) +- fix: null is no longer confused for an object [\#428](https://github.com/shelljs/shelljs/pull/428) ([nfischer](https://github.com/nfischer)) +- fix\(ls\): no trailing newline for empty directories [\#425](https://github.com/shelljs/shelljs/pull/425) ([nfischer](https://github.com/nfischer)) +- feat\(cp\): -P option, plus better handling of symlinks [\#421](https://github.com/shelljs/shelljs/pull/421) ([nfischer](https://github.com/nfischer)) +- docs\(exec\): fix docs about exec return type [\#419](https://github.com/shelljs/shelljs/pull/419) ([nfischer](https://github.com/nfischer)) +- docs\(error\): deprecate relying on string value [\#418](https://github.com/shelljs/shelljs/pull/418) ([nfischer](https://github.com/nfischer)) +- fix: error message now printed for fatal failures [\#417](https://github.com/shelljs/shelljs/pull/417) ([nfischer](https://github.com/nfischer)) +- issue-407: Add regular files unit tests and fix symlink copy behavior [\#409](https://github.com/shelljs/shelljs/pull/409) ([charlesverge](https://github.com/charlesverge)) +- refactor\(rm\): Remove duplicate code [\#408](https://github.com/shelljs/shelljs/pull/408) ([nfischer](https://github.com/nfischer)) +- docs: wildcards for all commands, other docs cleanups [\#404](https://github.com/shelljs/shelljs/pull/404) ([nfischer](https://github.com/nfischer)) +- test\(rm\): add tests to prevent a future regression [\#403](https://github.com/shelljs/shelljs/pull/403) ([nfischer](https://github.com/nfischer)) +- refactor\(string\): modify string protoype, but only for shelljs/global [\#401](https://github.com/shelljs/shelljs/pull/401) ([nfischer](https://github.com/nfischer)) +- feat: adding error codes to ShellJS [\#394](https://github.com/shelljs/shelljs/pull/394) ([nfischer](https://github.com/nfischer)) +- feature: use rechoir [\#384](https://github.com/shelljs/shelljs/pull/384) ([nfischer](https://github.com/nfischer)) +- refactor\(cp\): clean up code and fix \#376 [\#380](https://github.com/shelljs/shelljs/pull/380) ([nfischer](https://github.com/nfischer)) +- New commands: sort\(\), head\(\), and tail\(\) [\#379](https://github.com/shelljs/shelljs/pull/379) ([nfischer](https://github.com/nfischer)) +- Add unit tests to prevent regression \(see \#376\) [\#378](https://github.com/shelljs/shelljs/pull/378) ([nfischer](https://github.com/nfischer)) +- feat\(pipe\): add support for pipes between commands [\#370](https://github.com/shelljs/shelljs/pull/370) ([nfischer](https://github.com/nfischer)) +- refactor\(ls\): greatly simplify ls implimentation [\#369](https://github.com/shelljs/shelljs/pull/369) ([ariporad](https://github.com/ariporad)) +- chore: drop node v0.10 support [\#368](https://github.com/shelljs/shelljs/pull/368) ([ariporad](https://github.com/ariporad)) +- perf\(cd\): only run `stat` once [\#367](https://github.com/shelljs/shelljs/pull/367) ([ariporad](https://github.com/ariporad)) +- fix\(exec\): properly handles paths with spaces and quotes [\#365](https://github.com/shelljs/shelljs/pull/365) ([nfischer](https://github.com/nfischer)) +- test\(ln\): add tests for linking to cwd [\#364](https://github.com/shelljs/shelljs/pull/364) ([nfischer](https://github.com/nfischer)) +- fix\(verbose\): verbose-style logging is consistent [\#362](https://github.com/shelljs/shelljs/pull/362) ([nfischer](https://github.com/nfischer)) +- Refactor shellstring [\#360](https://github.com/shelljs/shelljs/pull/360) ([nfischer](https://github.com/nfischer)) +- feat\(glob\): use glob module for globbing [\#359](https://github.com/shelljs/shelljs/pull/359) ([nfischer](https://github.com/nfischer)) +- feat\(set\): add -f option to disable globbing [\#358](https://github.com/shelljs/shelljs/pull/358) ([nfischer](https://github.com/nfischer)) +- config.fatal now throws an exception [\#357](https://github.com/shelljs/shelljs/pull/357) ([jrmclaurin](https://github.com/jrmclaurin)) +- fix\(exec\): temp files are now cleaned up [\#354](https://github.com/shelljs/shelljs/pull/354) ([nfischer](https://github.com/nfischer)) +- feat\(glob\): glob support for \(almost\) all commands [\#352](https://github.com/shelljs/shelljs/pull/352) ([nfischer](https://github.com/nfischer)) +- feat\(grep\): add -l option [\#349](https://github.com/shelljs/shelljs/pull/349) ([nfischer](https://github.com/nfischer)) +- fix\(exec\): now actually supports shell option [\#348](https://github.com/shelljs/shelljs/pull/348) ([nfischer](https://github.com/nfischer)) +- feat\(touch\): supports multiple files [\#346](https://github.com/shelljs/shelljs/pull/346) ([nfischer](https://github.com/nfischer)) + +## [v0.6.0](https://github.com/shelljs/shelljs/tree/v0.6.0) (2016-02-05) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.5.3...v0.6.0) + +**Closed issues:** + +- option not recognized [\#334](https://github.com/shelljs/shelljs/issues/334) +- Feature request: Metadata with `ls` [\#323](https://github.com/shelljs/shelljs/issues/323) +- Gen-docs is broken [\#309](https://github.com/shelljs/shelljs/issues/309) +- `link -s` is broken for files on Windows [\#301](https://github.com/shelljs/shelljs/issues/301) +- Shelljs quits unexpectedly: [\#300](https://github.com/shelljs/shelljs/issues/300) +- Failing tests on Windows [\#296](https://github.com/shelljs/shelljs/issues/296) +- run-tests.js is broken for cmd.exe [\#294](https://github.com/shelljs/shelljs/issues/294) +- Support echo-ing environment variables [\#291](https://github.com/shelljs/shelljs/issues/291) +- Add Windows CI [\#287](https://github.com/shelljs/shelljs/issues/287) +- Add tests for the shjs utility [\#280](https://github.com/shelljs/shelljs/issues/280) +- Allow shjs utility to infer the extension for "filename." [\#278](https://github.com/shelljs/shelljs/issues/278) +- Ability to read the stdout buffer line-by-line [\#277](https://github.com/shelljs/shelljs/issues/277) +- Poor output for commands with multiple errors [\#267](https://github.com/shelljs/shelljs/issues/267) +- Travis ci build status says "unknown" [\#266](https://github.com/shelljs/shelljs/issues/266) +- wild card characters in filename not working as expected [\#262](https://github.com/shelljs/shelljs/issues/262) +- shell.exec - read internal variable [\#260](https://github.com/shelljs/shelljs/issues/260) +- cp and rename directory with -r doesn't match unix behavior [\#256](https://github.com/shelljs/shelljs/issues/256) +- console.log.apply throwing TypeError: Illegal Invocation [\#255](https://github.com/shelljs/shelljs/issues/255) +- How to exit on first error [\#253](https://github.com/shelljs/shelljs/issues/253) +- why not support set 'cwd' when invoke execAsync ? [\#250](https://github.com/shelljs/shelljs/issues/250) +- Not possible to check the failure of cd? [\#247](https://github.com/shelljs/shelljs/issues/247) +- By default shelljs runs command in root [\#246](https://github.com/shelljs/shelljs/issues/246) +- "Which" command not working properly on Windows Platform. [\#238](https://github.com/shelljs/shelljs/issues/238) +- Arguments [\#237](https://github.com/shelljs/shelljs/issues/237) +- sed\(\) should accept multiple file arguments [\#231](https://github.com/shelljs/shelljs/issues/231) +- shelljs.exec\('aaa && bbb'\) blocks [\#229](https://github.com/shelljs/shelljs/issues/229) +- Consider creating a GitHub Organization with more maintainers [\#223](https://github.com/shelljs/shelljs/issues/223) +- Doesn't work inside Electron [\#220](https://github.com/shelljs/shelljs/issues/220) +- \[idea\] Add chmodr function. [\#219](https://github.com/shelljs/shelljs/issues/219) +- Execute a file [\#211](https://github.com/shelljs/shelljs/issues/211) +- Where is standard error going to? [\#209](https://github.com/shelljs/shelljs/issues/209) +- boolean return value for string.to\(\) [\#205](https://github.com/shelljs/shelljs/issues/205) +- `common.error` doesn't throw [\#199](https://github.com/shelljs/shelljs/issues/199) +- Problems with exec \(sync\) on 0.12/io.js [\#197](https://github.com/shelljs/shelljs/issues/197) +- cp --update flag [\#172](https://github.com/shelljs/shelljs/issues/172) +- Is there a way to suppress pushd/popd output? [\#171](https://github.com/shelljs/shelljs/issues/171) +- Cannot recursively list all \*.js files [\#162](https://github.com/shelljs/shelljs/issues/162) +- exec\(\) breaks if executed in a deleted directory [\#157](https://github.com/shelljs/shelljs/issues/157) +- shjs command always exits with zero code [\#133](https://github.com/shelljs/shelljs/issues/133) +- Windows failing tests [\#127](https://github.com/shelljs/shelljs/issues/127) +- touch command [\#122](https://github.com/shelljs/shelljs/issues/122) +- Symbolic links are broken! [\#100](https://github.com/shelljs/shelljs/issues/100) +- interpret `--` as stdin [\#55](https://github.com/shelljs/shelljs/issues/55) +- Error ENOTEMPTY when deleting a directory recursively. [\#49](https://github.com/shelljs/shelljs/issues/49) +- Cross-platform way to add to PATH [\#32](https://github.com/shelljs/shelljs/issues/32) +- `mv` fails on block, character, fifo [\#25](https://github.com/shelljs/shelljs/issues/25) +- ls -l [\#22](https://github.com/shelljs/shelljs/issues/22) + +**Merged pull requests:** + +- feat\(set\): add new set\(\) command [\#329](https://github.com/shelljs/shelljs/pull/329) ([nfischer](https://github.com/nfischer)) +- Fix symlinking on Windows [\#322](https://github.com/shelljs/shelljs/pull/322) ([BYK](https://github.com/BYK)) +- Rewrite .gitignore to be more comprehensive [\#321](https://github.com/shelljs/shelljs/pull/321) ([BYK](https://github.com/BYK)) +- chore\(gitter/travis\): add gitter webhook to travis [\#313](https://github.com/shelljs/shelljs/pull/313) ([ariporad](https://github.com/ariporad)) +- chore\(LGTM\): add LGTM config files [\#312](https://github.com/shelljs/shelljs/pull/312) ([ariporad](https://github.com/ariporad)) +- feat\(ls\): add -d flag to ls\(\) [\#311](https://github.com/shelljs/shelljs/pull/311) ([nfischer](https://github.com/nfischer)) +- fix\(gen-docs\): fix issue where docs are generated wrong [\#310](https://github.com/shelljs/shelljs/pull/310) ([nfischer](https://github.com/nfischer)) +- chore\(package\): remove v0.8 from engines list [\#308](https://github.com/shelljs/shelljs/pull/308) ([nfischer](https://github.com/nfischer)) +- travis: Mark as not using `sudo` and do not test 0.11 [\#307](https://github.com/shelljs/shelljs/pull/307) ([TimothyGu](https://github.com/TimothyGu)) +- fix: jshint works on Windows [\#295](https://github.com/shelljs/shelljs/pull/295) ([nfischer](https://github.com/nfischer)) +- feat: add tilde expansion to expand\(\) [\#293](https://github.com/shelljs/shelljs/pull/293) ([nfischer](https://github.com/nfischer)) +- style: make docs more consistent [\#292](https://github.com/shelljs/shelljs/pull/292) ([nfischer](https://github.com/nfischer)) +- update `exec` docs to match implemented behaviour [\#289](https://github.com/shelljs/shelljs/pull/289) ([vise890](https://github.com/vise890)) +- chore: update github URL in package.json [\#288](https://github.com/shelljs/shelljs/pull/288) ([nfischer](https://github.com/nfischer)) +- docs\(spelling\): fix typo in source comment [\#285](https://github.com/shelljs/shelljs/pull/285) ([nfischer](https://github.com/nfischer)) +- chore\(travis\): add OS X to Travis CI [\#283](https://github.com/shelljs/shelljs/pull/283) ([nfischer](https://github.com/nfischer)) +- Don't do `console.log.apply\(this, ...\)`. [\#274](https://github.com/shelljs/shelljs/pull/274) ([ariporad](https://github.com/ariporad)) +- Implementing cd\('-'\) to behave like Bash's "cd -" [\#273](https://github.com/shelljs/shelljs/pull/273) ([nfischer](https://github.com/nfischer)) +- Fix cp to match unix behavior [\#271](https://github.com/shelljs/shelljs/pull/271) ([freitagbr](https://github.com/freitagbr)) +- Commands that have multiple errors now produce cleaner log output [\#268](https://github.com/shelljs/shelljs/pull/268) ([nfischer](https://github.com/nfischer)) +- Support exit code in shjs. [\#252](https://github.com/shelljs/shelljs/pull/252) ([bryce-gibson](https://github.com/bryce-gibson)) +- add touch\(1\) [\#249](https://github.com/shelljs/shelljs/pull/249) ([blockloop](https://github.com/blockloop)) +- Fix `os.tmpdir` bug [\#240](https://github.com/shelljs/shelljs/pull/240) ([BYK](https://github.com/BYK)) +- Make sure Which\(\) on Windows platform always return the command with … [\#239](https://github.com/shelljs/shelljs/pull/239) ([TingluoHuang](https://github.com/TingluoHuang)) +- Add target node.js \(iojs v1, v2, v3\) [\#230](https://github.com/shelljs/shelljs/pull/230) ([sanemat](https://github.com/sanemat)) +- feat-multisymbolic + Support for directory entry \(capital X in chmod terms\) [\#228](https://github.com/shelljs/shelljs/pull/228) ([rezonant](https://github.com/rezonant)) +- Fixes an issue with multi-symbolic mode specification \(ie a-rwx,u+rw\) [\#227](https://github.com/shelljs/shelljs/pull/227) ([rezonant](https://github.com/rezonant)) +- Memoized the result of target invocation [\#216](https://github.com/shelljs/shelljs/pull/216) ([rizowski](https://github.com/rizowski)) +- remove empty for loop and leaked i var [\#166](https://github.com/shelljs/shelljs/pull/166) ([ratbeard](https://github.com/ratbeard)) +- Wrap script name in double quotes [\#135](https://github.com/shelljs/shelljs/pull/135) ([ndelitski](https://github.com/ndelitski)) +- Fixed coffeescript syntax in top example [\#99](https://github.com/shelljs/shelljs/pull/99) ([maxnordlund](https://github.com/maxnordlund)) +- fix\(touch\): enhance parseOptions and fix touch's -r flag [\#341](https://github.com/shelljs/shelljs/pull/341) ([nfischer](https://github.com/nfischer)) +- chore\(.npmignore\): update npmignore [\#339](https://github.com/shelljs/shelljs/pull/339) ([ariporad](https://github.com/ariporad)) +- Release v0.6.0 [\#338](https://github.com/shelljs/shelljs/pull/338) ([ariporad](https://github.com/ariporad)) +- docs\(README\): remove coffeescript from README [\#337](https://github.com/shelljs/shelljs/pull/337) ([ariporad](https://github.com/ariporad)) +- fix\(cp\): add -n option, make -f default behavior [\#336](https://github.com/shelljs/shelljs/pull/336) ([nfischer](https://github.com/nfischer)) +- feat\(exec\): allow all exec options to pass through [\#335](https://github.com/shelljs/shelljs/pull/335) ([nfischer](https://github.com/nfischer)) +- fix\(mv\): add -n option, make -f default behavior [\#328](https://github.com/shelljs/shelljs/pull/328) ([nfischer](https://github.com/nfischer)) +- fix\(cat\): make behavior more like unix [\#326](https://github.com/shelljs/shelljs/pull/326) ([nfischer](https://github.com/nfischer)) +- feat\(ls\): add -l option [\#324](https://github.com/shelljs/shelljs/pull/324) ([nfischer](https://github.com/nfischer)) +- style\(test/which\): make test/which.js conform to the style guidelines [\#320](https://github.com/shelljs/shelljs/pull/320) ([ariporad](https://github.com/ariporad)) +- chore\(appveyor\): add badge [\#316](https://github.com/shelljs/shelljs/pull/316) ([nfischer](https://github.com/nfischer)) +- fix\(windows\): fix shjs commands for windows [\#315](https://github.com/shelljs/shelljs/pull/315) ([nfischer](https://github.com/nfischer)) +- feat\(sed\): support multiple file names [\#314](https://github.com/shelljs/shelljs/pull/314) ([nfischer](https://github.com/nfischer)) +- feat\(cd\): cd\(\) \(no args\) changes to home directory [\#306](https://github.com/shelljs/shelljs/pull/306) ([nfischer](https://github.com/nfischer)) +- test\(shjs\): add tests for shjs [\#304](https://github.com/shelljs/shelljs/pull/304) ([ariporad](https://github.com/ariporad)) +- fix: regexes are more consistent with sed and grep [\#303](https://github.com/shelljs/shelljs/pull/303) ([nfischer](https://github.com/nfischer)) +- Add appveyor.yml config file [\#299](https://github.com/shelljs/shelljs/pull/299) ([nfischer](https://github.com/nfischer)) +- Fix tests on Windows [\#297](https://github.com/shelljs/shelljs/pull/297) ([BYK](https://github.com/BYK)) +- Search PATHEXT instead of 3 hardcoded values [\#290](https://github.com/shelljs/shelljs/pull/290) ([isiahmeadows](https://github.com/isiahmeadows)) +- Fix relative symlinks [\#282](https://github.com/shelljs/shelljs/pull/282) ([freitagbr](https://github.com/freitagbr)) +- Make to and toEnd chainable [\#276](https://github.com/shelljs/shelljs/pull/276) ([TimothyGu](https://github.com/TimothyGu)) + +## [v0.5.3](https://github.com/shelljs/shelljs/tree/v0.5.3) (2015-08-11) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.5.2...v0.5.3) + +**Merged pull requests:** + +- Manually closing streams [\#222](https://github.com/shelljs/shelljs/pull/222) ([JulianLaval](https://github.com/JulianLaval)) + +## [v0.5.2](https://github.com/shelljs/shelljs/tree/v0.5.2) (2015-08-10) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.5.1...v0.5.2) + +**Closed issues:** + +- Cannot run shell.exec [\#217](https://github.com/shelljs/shelljs/issues/217) +- write after end: internal error [\#206](https://github.com/shelljs/shelljs/issues/206) + +**Merged pull requests:** + +- Update README.md [\#221](https://github.com/shelljs/shelljs/pull/221) ([giosh94mhz](https://github.com/giosh94mhz)) +- prevent internal error: write after end [\#214](https://github.com/shelljs/shelljs/pull/214) ([charlierudolph](https://github.com/charlierudolph)) + +## [v0.5.1](https://github.com/shelljs/shelljs/tree/v0.5.1) (2015-06-05) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.5.0...v0.5.1) + +**Closed issues:** + +- cd into home directory [\#9](https://github.com/shelljs/shelljs/issues/9) + +**Merged pull requests:** + +- Fix issue \#49: Retry rmdirSync on Windows for up to 1 second if files still exist. [\#179](https://github.com/shelljs/shelljs/pull/179) ([andreialecu](https://github.com/andreialecu)) + +## [v0.5.0](https://github.com/shelljs/shelljs/tree/v0.5.0) (2015-05-19) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.3.0...v0.5.0) + +**Closed issues:** + +- Enter text to prompt [\#203](https://github.com/shelljs/shelljs/issues/203) +- Find which shell is being used [\#195](https://github.com/shelljs/shelljs/issues/195) +- Pass command line params to the make tool [\#188](https://github.com/shelljs/shelljs/issues/188) +- Is it possible to call exec with a command containing new lines ? [\#177](https://github.com/shelljs/shelljs/issues/177) +- The installation would break on Windows 7 [\#161](https://github.com/shelljs/shelljs/issues/161) +- Q.ninvoke\(\) returns undefined [\#153](https://github.com/shelljs/shelljs/issues/153) +- installed shelljs on osx but reported error: npm ERR! 404 '%5B-g%5D' is not in the npm registry. [\#124](https://github.com/shelljs/shelljs/issues/124) +- "ln" not found \(OS X\) [\#106](https://github.com/shelljs/shelljs/issues/106) +- Using shelljs in a CLI app. [\#91](https://github.com/shelljs/shelljs/issues/91) + +**Merged pull requests:** + +- Breaking: Allow -- as args separators \(fixes \#188\) [\#207](https://github.com/shelljs/shelljs/pull/207) ([nzakas](https://github.com/nzakas)) +- Update .travis.yml [\#190](https://github.com/shelljs/shelljs/pull/190) ([arturadib](https://github.com/arturadib)) +- Use new child\_process.execSync instead of busywaiting [\#189](https://github.com/shelljs/shelljs/pull/189) ([devTristan](https://github.com/devTristan)) +- Update README.md: explains how to access "config" [\#145](https://github.com/shelljs/shelljs/pull/145) ([kerphi](https://github.com/kerphi)) +- Fix to set state.error before throw the exception [\#120](https://github.com/shelljs/shelljs/pull/120) ([abdul-martinez](https://github.com/abdul-martinez)) +- Add -l and -s support to grep. [\#116](https://github.com/shelljs/shelljs/pull/116) ([idearat](https://github.com/idearat)) + +## [v0.3.0](https://github.com/shelljs/shelljs/tree/v0.3.0) (2014-05-08) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.2.6...v0.3.0) + +**Closed issues:** + +- grep\(\) should fully support globing [\#118](https://github.com/shelljs/shelljs/issues/118) +- sed\(\) could support replacement function [\#115](https://github.com/shelljs/shelljs/issues/115) +- How would you close an exec process that runs indefinitely? [\#113](https://github.com/shelljs/shelljs/issues/113) +- listen for intermittent output of a long-running child process [\#111](https://github.com/shelljs/shelljs/issues/111) +- Cannot find module 'shelljs' after installing shelljs with npm [\#109](https://github.com/shelljs/shelljs/issues/109) +- Massive CPU usage on exec\(\) windows [\#108](https://github.com/shelljs/shelljs/issues/108) +- cp skipping dot files? [\#79](https://github.com/shelljs/shelljs/issues/79) +- $variables in exec\(\) aren't handled correctly [\#11](https://github.com/shelljs/shelljs/issues/11) +- debug flag that prints commands instead of executing [\#8](https://github.com/shelljs/shelljs/issues/8) + +**Merged pull requests:** + +- grep\(\) support for globing, fixes \#118 [\#119](https://github.com/shelljs/shelljs/pull/119) ([utensil](https://github.com/utensil)) +- make sed\(\) support replacement function, fixes \#115 [\#117](https://github.com/shelljs/shelljs/pull/117) ([utensil](https://github.com/utensil)) +- which\(\) should only find files, not directories [\#110](https://github.com/shelljs/shelljs/pull/110) ([panrafal](https://github.com/panrafal)) +- Added the New BSD license to the package.json. [\#105](https://github.com/shelljs/shelljs/pull/105) ([keskival](https://github.com/keskival)) +- Added win32 support to ln [\#104](https://github.com/shelljs/shelljs/pull/104) ([jamon](https://github.com/jamon)) +- Fix ln using bad paths when given abspaths. [\#89](https://github.com/shelljs/shelljs/pull/89) ([Schoonology](https://github.com/Schoonology)) +- Add ln support, including both -s and -f options. [\#88](https://github.com/shelljs/shelljs/pull/88) ([Schoonology](https://github.com/Schoonology)) +- add support for symlinking \(junctions\) on win32 [\#87](https://github.com/shelljs/shelljs/pull/87) ([jamon](https://github.com/jamon)) + +## [v0.2.6](https://github.com/shelljs/shelljs/tree/v0.2.6) (2013-09-22) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.2.5...v0.2.6) + +**Closed issues:** + +- Versions 0.2.4 and 0.2.3 keep throwing strange errors [\#82](https://github.com/shelljs/shelljs/issues/82) +- Add global pollution tests [\#33](https://github.com/shelljs/shelljs/issues/33) + +## [v0.2.5](https://github.com/shelljs/shelljs/tree/v0.2.5) (2013-09-11) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.2.4...v0.2.5) + +**Closed issues:** + +- shelljs.exec stalls on Red Hat when script is invoked with 'sudo -u username' [\#72](https://github.com/shelljs/shelljs/issues/72) + +## [v0.2.4](https://github.com/shelljs/shelljs/tree/v0.2.4) (2013-09-11) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.2.3...v0.2.4) + +## [v0.2.3](https://github.com/shelljs/shelljs/tree/v0.2.3) (2013-09-09) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.2.2...v0.2.3) + +**Merged pull requests:** + +- Make shell.exec\(\) treat process error return codes as shelljs errors [\#80](https://github.com/shelljs/shelljs/pull/80) ([nilsbunger](https://github.com/nilsbunger)) + +## [v0.2.2](https://github.com/shelljs/shelljs/tree/v0.2.2) (2013-09-02) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.1.4...v0.2.2) + +**Closed issues:** + +- which and node\_modules [\#63](https://github.com/shelljs/shelljs/issues/63) +- cannot install with nodejs 0.10.2 [\#57](https://github.com/shelljs/shelljs/issues/57) + +**Merged pull requests:** + +- Addition of a toEnd\(\) function modeled after the Unix \>\> pipe. [\#78](https://github.com/shelljs/shelljs/pull/78) ([andreweduffy](https://github.com/andreweduffy)) +- Added appendTo\(\) function to imitate '\>\>' redirect-and-append pipe. [\#75](https://github.com/shelljs/shelljs/pull/75) ([andreweduffy](https://github.com/andreweduffy)) +- Fix a small typo in README.md [\#71](https://github.com/shelljs/shelljs/pull/71) ([asmblah](https://github.com/asmblah)) +- adding an `.npmignore` file [\#70](https://github.com/shelljs/shelljs/pull/70) ([stephenmathieson](https://github.com/stephenmathieson)) +- tempdir: use `os.tmpDir` when possible [\#67](https://github.com/shelljs/shelljs/pull/67) ([stephenmathieson](https://github.com/stephenmathieson)) + +## [v0.1.4](https://github.com/shelljs/shelljs/tree/v0.1.4) (2013-05-10) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.1.3...v0.1.4) + +**Merged pull requests:** + +- removing extra fs calls [\#62](https://github.com/shelljs/shelljs/pull/62) ([stephenmathieson](https://github.com/stephenmathieson)) +- moving \_jshint\_ to a development dependency [\#61](https://github.com/shelljs/shelljs/pull/61) ([stephenmathieson](https://github.com/stephenmathieson)) +- Make the maximum buffersize 20 MB. [\#59](https://github.com/shelljs/shelljs/pull/59) ([waddlesplash](https://github.com/waddlesplash)) + +## [v0.1.3](https://github.com/shelljs/shelljs/tree/v0.1.3) (2013-04-21) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.1.2...v0.1.3) + +**Merged pull requests:** + +- test\('-L', badlink\) should return true [\#56](https://github.com/shelljs/shelljs/pull/56) ([lge88](https://github.com/lge88)) +- exec options now allows `silent:true` with callback. [\#54](https://github.com/shelljs/shelljs/pull/54) ([iapain](https://github.com/iapain)) +- Add Zepto to README [\#53](https://github.com/shelljs/shelljs/pull/53) ([madrobby](https://github.com/madrobby)) + +## [v0.1.2](https://github.com/shelljs/shelljs/tree/v0.1.2) (2013-01-08) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.1.1...v0.1.2) + +**Closed issues:** + +- pushd/popd [\#24](https://github.com/shelljs/shelljs/issues/24) + +**Merged pull requests:** + +- Implemented chmod command. Github issue 35 [\#48](https://github.com/shelljs/shelljs/pull/48) ([brandonramirez](https://github.com/brandonramirez)) + +## [v0.1.1](https://github.com/shelljs/shelljs/tree/v0.1.1) (2013-01-01) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.1.0...v0.1.1) + +**Merged pull requests:** + +- Work in progress: pushd/popd/dirs [\#47](https://github.com/shelljs/shelljs/pull/47) ([mstade](https://github.com/mstade)) + +## [v0.1.0](https://github.com/shelljs/shelljs/tree/v0.1.0) (2012-12-26) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.9...v0.1.0) + +**Closed issues:** + +- test\(\) for binary file? [\#45](https://github.com/shelljs/shelljs/issues/45) +- Inconsistent behaviour of cp command with directories. [\#44](https://github.com/shelljs/shelljs/issues/44) +- Executing SSH with ShellJs [\#43](https://github.com/shelljs/shelljs/issues/43) + +**Merged pull requests:** + +- Fix for \#44 [\#46](https://github.com/shelljs/shelljs/pull/46) ([mstade](https://github.com/mstade)) +- Fix single/double quotes in exec [\#42](https://github.com/shelljs/shelljs/pull/42) ([danielepolencic](https://github.com/danielepolencic)) + +## [v0.0.9](https://github.com/shelljs/shelljs/tree/v0.0.9) (2012-12-01) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.8...v0.0.9) + +**Closed issues:** + +- silent output [\#40](https://github.com/shelljs/shelljs/issues/40) +- asynchronous exec [\#34](https://github.com/shelljs/shelljs/issues/34) + +**Merged pull requests:** + +- Passed process arguments to executable script [\#36](https://github.com/shelljs/shelljs/pull/36) ([Zanisimo](https://github.com/Zanisimo)) + +## [v0.0.8](https://github.com/shelljs/shelljs/tree/v0.0.8) (2012-10-11) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.7...v0.0.8) + +**Closed issues:** + +- exec with callback should automatically be async [\#31](https://github.com/shelljs/shelljs/issues/31) +- Exporting variables. [\#30](https://github.com/shelljs/shelljs/issues/30) +- Detecting shelljs/node [\#27](https://github.com/shelljs/shelljs/issues/27) + +**Merged pull requests:** + +- fix: global leak 'stats' [\#29](https://github.com/shelljs/shelljs/pull/29) ([ando-takahiro](https://github.com/ando-takahiro)) +- -a includes . and ..; -A does not [\#28](https://github.com/shelljs/shelljs/pull/28) ([aeosynth](https://github.com/aeosynth)) + +## [v0.0.7](https://github.com/shelljs/shelljs/tree/v0.0.7) (2012-09-23) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.6...v0.0.7) + +**Closed issues:** + +- gh-pages: clicking 'fork me' just reloads the page [\#26](https://github.com/shelljs/shelljs/issues/26) +- Not declared local var implies possible memory leak [\#21](https://github.com/shelljs/shelljs/issues/21) +- Cannot echo a string that starts with - [\#20](https://github.com/shelljs/shelljs/issues/20) +- Unexpected cp behaviour with directories [\#15](https://github.com/shelljs/shelljs/issues/15) + +**Merged pull requests:** + +- add primaries to \_test [\#23](https://github.com/shelljs/shelljs/pull/23) ([aeosynth](https://github.com/aeosynth)) + +## [v0.0.6](https://github.com/shelljs/shelljs/tree/v0.0.6) (2012-08-07) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.6pre2...v0.0.6) + +**Merged pull requests:** + +- Fixed a global variable leak [\#16](https://github.com/shelljs/shelljs/pull/16) ([dallonf](https://github.com/dallonf)) + +## [v0.0.6pre2](https://github.com/shelljs/shelljs/tree/v0.0.6pre2) (2012-05-25) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.6pre1...v0.0.6pre2) + +## [v0.0.6pre1](https://github.com/shelljs/shelljs/tree/v0.0.6pre1) (2012-05-25) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.5...v0.0.6pre1) + +## [v0.0.5](https://github.com/shelljs/shelljs/tree/v0.0.5) (2012-05-24) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.5pre4...v0.0.5) + +**Closed issues:** + +- global.key assigned value 'async' as a result of shell.exec\(...\) [\#12](https://github.com/shelljs/shelljs/issues/12) + +**Merged pull requests:** + +- Add support for grep option -v. [\#13](https://github.com/shelljs/shelljs/pull/13) ([kkujala](https://github.com/kkujala)) + +## [v0.0.5pre4](https://github.com/shelljs/shelljs/tree/v0.0.5pre4) (2012-03-27) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.5pre3...v0.0.5pre4) + +## [v0.0.5pre3](https://github.com/shelljs/shelljs/tree/v0.0.5pre3) (2012-03-27) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.5pre2...v0.0.5pre3) + +## [v0.0.5pre2](https://github.com/shelljs/shelljs/tree/v0.0.5pre2) (2012-03-26) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.5pre1...v0.0.5pre2) + +## [v0.0.5pre1](https://github.com/shelljs/shelljs/tree/v0.0.5pre1) (2012-03-26) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.4...v0.0.5pre1) + +**Closed issues:** + +- rm\(\) does not respect read/write modes [\#6](https://github.com/shelljs/shelljs/issues/6) + +## [v0.0.4](https://github.com/shelljs/shelljs/tree/v0.0.4) (2012-03-22) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.3...v0.0.4) + +**Closed issues:** + +- "For convenient iteration via `for in`, ..."? [\#4](https://github.com/shelljs/shelljs/issues/4) + +## [v0.0.3](https://github.com/shelljs/shelljs/tree/v0.0.3) (2012-03-21) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.2...v0.0.3) + +## [v0.0.2](https://github.com/shelljs/shelljs/tree/v0.0.2) (2012-03-15) +[Full Changelog](https://github.com/shelljs/shelljs/compare/v0.0.2pre1...v0.0.2) + +## [v0.0.2pre1](https://github.com/shelljs/shelljs/tree/v0.0.2pre1) (2012-03-03) + + +\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)* \ No newline at end of file diff --git a/RELEASE.md b/RELEASE.md index 26e17d8..074b4c6 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -1,13 +1,20 @@ # Release steps -* Ensure master passes CI tests -* Bump version in package.json. Any breaking change or new feature should bump - minor (or even major). Non-breaking changes or fixes can just bump patch. -* Update README manually if the changes are not documented in-code. Run +1. Ensure master passes CI tests +1. Bump version: + - `$ npm version ` + + >`major` - breaking API changes + >`minor` - backwards-compatible features + >`patch` - backwards-compatible bug fixes +1. Update README manually if the changes are not documented in-code. Run `scripts/generate-docs.js` just to be safe -* Commit -* `$ git tag ` (see `git tag -l` for latest) -* `$ git push origin master --tags` -* `$ npm publish .` -* Generate the documentup website by visiting +1. Update CHANGELOG.md + - `$ npm run changelog` + - `$ git push` +1. Push the bump commit, version tags, and publish + - `$ git push` + - `$ git push --tags` + - `$ npm publish` +1. Generate the documentup website by visiting [http://documentup.com/shelljs/shelljs/__recompile] in your browser diff --git a/package.json b/package.json index 94fb501..6a2d7df 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,8 @@ "homepage": "http://github.com/shelljs/shelljs", "main": "./shell.js", "scripts": { - "test": "node scripts/run-tests" + "test": "node scripts/run-tests", + "changelog": "bash scripts/changelog.sh" }, "bin": { "shjs": "./bin/shjs" diff --git a/scripts/changelog.sh b/scripts/changelog.sh new file mode 100644 index 0000000..5808692 --- /dev/null +++ b/scripts/changelog.sh @@ -0,0 +1,28 @@ +#!/usr/bin/env bash + +# Creates a changelog for the current build and puts it in the root +# Commits the changelog if it updated +# Does not push commit + +run() { + echo "...generating changelog (be patient)" + + curl -X POST -s "github-changelog-api.herokuapp.com/shelljs/shelljs" > CHANGELOG.md + + local changelog_was_updated=false + for file in $(git ls-files --exclude-standard --modified --others); do + [[ ${file} == "CHANGELOG.md" ]] && changelog_was_updated=true + done + + if ${changelog_was_updated}; then + echo "...committing updated changelog" + local current_user=$(git config user.name || echo "unknown") + git add CHANGELOG.md + git commit -m "docs(changelog): updated by $current_user" + echo "Done. You can now 'git push' the updated changelog." + else + echo "CHANGELOG.md already up-to-date." + fi +} + +run