{"action":"created","issue":{"url":"https://api.github.com/repos/shelljs/shelljs/issues/398","repository_url":"https://api.github.com/repos/shelljs/shelljs","labels_url":"https://api.github.com/repos/shelljs/shelljs/issues/398/labels{/name}","comments_url":"https://api.github.com/repos/shelljs/shelljs/issues/398/comments","events_url":"https://api.github.com/repos/shelljs/shelljs/issues/398/events","html_url":"https://github.com/shelljs/shelljs/issues/398","id":141474705,"number":398,"title":"Edit the docs to emphasize ShellStrings and Pipes","user":{"login":"nfischer","id":5801521,"avatar_url":"https://avatars.githubusercontent.com/u/5801521?v=3","gravatar_id":"","url":"https://api.github.com/users/nfischer","html_url":"https://github.com/nfischer","followers_url":"https://api.github.com/users/nfischer/followers","following_url":"https://api.github.com/users/nfischer/following{/other_user}","gists_url":"https://api.github.com/users/nfischer/gists{/gist_id}","starred_url":"https://api.github.com/users/nfischer/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/nfischer/subscriptions","organizations_url":"https://api.github.com/users/nfischer/orgs","repos_url":"https://api.github.com/users/nfischer/repos","events_url":"https://api.github.com/users/nfischer/events{/privacy}","received_events_url":"https://api.github.com/users/nfischer/received_events","type":"User","site_admin":false},"labels":[{"url":"https://api.github.com/repos/shelljs/shelljs/labels/docs","name":"docs","color":"0052cc"},{"url":"https://api.github.com/repos/shelljs/shelljs/labels/help%20wanted","name":"help wanted","color":"159818"},{"url":"https://api.github.com/repos/shelljs/shelljs/labels/medium%20priority","name":"medium priority","color":"fbca04"}],"state":"open","locked":false,"assignee":null,"milestone":{"url":"https://api.github.com/repos/shelljs/shelljs/milestones/3","html_url":"https://github.com/shelljs/shelljs/milestones/v0.7.0","labels_url":"https://api.github.com/repos/shelljs/shelljs/milestones/3/labels","id":1555794,"number":3,"title":"v0.7.0","description":"","creator":{"login":"ariporad","id":1817508,"avatar_url":"https://avatars.githubusercontent.com/u/1817508?v=3","gravatar_id":"","url":"https://api.github.com/users/ariporad","html_url":"https://github.com/ariporad","followers_url":"https://api.github.com/users/ariporad/followers","following_url":"https://api.github.com/users/ariporad/following{/other_user}","gists_url":"https://api.github.com/users/ariporad/gists{/gist_id}","starred_url":"https://api.github.com/users/ariporad/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/ariporad/subscriptions","organizations_url":"https://api.github.com/users/ariporad/orgs","repos_url":"https://api.github.com/users/ariporad/repos","events_url":"https://api.github.com/users/ariporad/events{/privacy}","received_events_url":"https://api.github.com/users/ariporad/received_events","type":"User","site_admin":false},"open_issues":6,"closed_issues":38,"state":"open","created_at":"2016-02-01T14:48:26Z","updated_at":"2016-03-17T04:14:50Z","due_on":null,"closed_at":null},"comments":1,"created_at":"2016-03-17T04:14:50Z","updated_at":"2016-03-17T12:49:26Z","closed_at":null,"body":"The introduction of `ShellStrings` is a pretty big change, since a lot of people rely on the old behavior of strings have the `.to()` method (here's an example from our friends over at [dthree/cash](https://github.com/dthree/cash/blob/master/test/cat.js#L10-L12)).\r\n\r\nWe might want to consider adding that back in to the `String.prototype` for now, and give a deprecation warning, since this might be a big impediment to users migrating to the new version. Or, if we decide to keep it as-is, we should document it a bit more clearly, and make it obvious for how people can create a file with the syntax:\r\n\r\n```javascript\r\nShellString('some text').to('file.txt');\r\n```\r\n\r\nAlso, I think pipes are one of the more useful features in ShellJS v0.7, so these should probably be advertised better in the docs.\r\n\r\nOn a related note, it might be worth starting guides in the wiki pages about how to migrate from version to version. We've been introducing quite a few breaking changes, so it might ease the transition for users to have these breaking changes highlighted (and not only buried in the changelog with all the features/bug fixes/etc.)."},"comment":{"url":"https://api.github.com/repos/shelljs/shelljs/issues/comments/197864253","html_url":"https://github.com/shelljs/shelljs/issues/398#issuecomment-197864253","issue_url":"https://api.github.com/repos/shelljs/shelljs/issues/398","id":197864253,"user":{"login":"dthree","id":10319897,"avatar_url":"https://avatars.githubusercontent.com/u/10319897?v=3","gravatar_id":"","url":"https://api.github.com/users/dthree","html_url":"https://github.com/dthree","followers_url":"https://api.github.com/users/dthree/followers","following_url":"https://api.github.com/users/dthree/following{/other_user}","gists_url":"https://api.github.com/users/dthree/gists{/gist_id}","starred_url":"https://api.github.com/users/dthree/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/dthree/subscriptions","organizations_url":"https://api.github.com/users/dthree/orgs","repos_url":"https://api.github.com/users/dthree/repos","events_url":"https://api.github.com/users/dthree/events{/privacy}","received_events_url":"https://api.github.com/users/dthree/received_events","type":"User","site_admin":false},"created_at":"2016-03-17T12:49:26Z","updated_at":"2016-03-17T12:49:26Z","body":"Agreed. It's kind of awkward that ShellJS is not `v1.0`, when it has been such a stable part of the Node ecosystem for so long and is in production use in a ton of applications. It should be `1.0` already, which would address these semver breaks."}}