sv 0.4.3 → 0.5.0

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 [these people](https://github.com/sveltejs/cli/graphs/contributors)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,142 +1,34 @@
-# sv
+# sv - the Svelte CLI
 
-[![npm version](https://badge.fury.io/js/sv.svg)](https://www.npmjs.com/package/sv)
-[![Travis CI Build Status](https://travis-ci.org/chbrown/sv.svg)](https://travis-ci.org/chbrown/sv)
-[![Coverage Status](https://coveralls.io/repos/chbrown/sv/badge.svg)](https://coveralls.io/github/chbrown/sv)
+A CLI for creating new [SvelteKit](https://kit.svelte.dev) projects and adding functionality to existing ones. Just run...
 
-For all your separated value needs.
+```bash
+npx sv
+```
 
-* `sv.Stringifier` is a [Readable stream](http://nodejs.org/api/stream.html#stream_class_stream_readable).
-* `sv.Parser` is a [Writable stream](http://nodejs.org/api/stream.html#stream_class_stream_writable).
+...and follow the prompts.
 
-## Install
+## API
 
-    npm install sv
+You can also use `sv` programmatically:
 
-The `optimist` dependency is only required for command line use.
+```js
+import { create } from 'sv';
 
-## API usage
+await create('my-new-app', {
+  name: 'my-new-app',
+  template: 'default' // or 'skeleton' or 'skeletonlib'
+});
+```
 
-All tabular data must / will have column names on the first row.
+`checkjs` means your project will use TypeScript to typecheck JavaScript via [JSDoc comments](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html).
 
-### Parsing
+## Acknowledgements
 
-sprints.csv:
-
-    index	name	time
-    1	chris	1:18
-    2	daniel	1:17
-    3	lewis	1:30
-    4	stephen	1:16
-    5	larry	1:32
-
-And in node:
-
-    var sv = require('sv');
-    var parser = new sv.Parser();
-    parser.on('data', function(obj) {
-      console.log('sprinter ->', obj);
-    });
-
-    var fs = require('fs');
-    var sprints = fs.createReadStream('sprints.csv', {encoding: 'utf8'});
-    sprints.pipe(parser);
-
-### Stringifying
-
-    var expenses = [
-      {name: 'Tip'                },
-      {name: 'Lunch', amount: 5.90},
-      {name: 'Latte', amount: 3.15},
-      {name: 'Paper', amount: 2.10},
-      {name: 'Pens' , amount: 4.59},
-      {               amount: 9.16}
-    ];
-
-    var sv = require('sv');
-    var stringifier = new sv.Stringifier({peek: 2, missing: 'n/a'});
-    stringifier.pipe(process.stdout);
-    expenses.forEach(function(expense) {
-      stringifier.write(expense);
-    });
-
-    // if you write set 'peek' to more rows than you have in your data,
-    // you'll need to call stringifier end so that they get flushed.
-    stringifier.end();
-
-* N.b.: If you pipe a buffer or (i.e., with a stringifier) into a parser, the
-  parser will not receive any encoding. You _must_ set the encoding on the
-  parser in those cases.
-
-### Stringifier features:
-
-1. Infer column names from a list of objects.
-2. Convert from objects to csv / tsv plaintext.
-   * Also allows writing arrays / strings directly.
-3. Write header automatically.
-
-### Parser features:
-
-1. Infer delimiter from input.
-2. Infer column names from first line of input.
-3. Handle universal newlines (`\r`, `\r\n`, or `\n`).
-
-## CLI usage
-
-    shopt -s globstar
-    for csv in ~/corpora/testsheets/**/*.csv; do
-      echo
-      file "$csv"
-      echo "Tunneling through multiple 'sv' calls should be transparent."
-      cat "$csv" | sv -j | wc -l
-      cat "$csv" | sv | sv -j | wc -l
-    done
-
-## TODO
-
-* Decide how to encode a field like {id: 1, name: '"chris'},
-  when the delimiter is `,` and quotechar is `"`.
-  - This is weird because it doesn't *need* quoting, but without, the
-    quotechar marker will trigger an `inside` state, but there's no end quote.)
-
-
-# Development notes
-
-## Characters codes
-
-Line separators:
-
-* `\n` = 10 (newline)
-* `\r` = 13 (return)
-
-Field separators:
-
-* `\t` = 9 (tab)
-* ` ` = 32 (space)
-* `,` = 44 (comma)
-* `;` = 59 (semicolon)
-
-Field quotations:
-
-* `"` = 34 (double quote)
-* `'` = 39 (single quote)
-* <code>`</code> = 96 (backtick)
-
-Escapes:
-
-* `\` = 92 (backslash)
-
-## Debugging helper:
-
-    function logEvents(emitter, prefix, names) {
-      names.forEach(function(name) {
-        emitter.on(name, function(/*...*/) {
-          console.error(prefix + ':' + name, arguments);
-        });
-      });
-    }
+Thank you to [Christopher Brown](https://github.com/chbrown) who originally owned the `sv` name on npm for graciously allowing it to be used for this package. You can find the original `sv` package at [`@chbrown/sv`](https://www.npmjs.com/package/@chbrown/sv).
 
+This project was formed by merging the `create-svelte` and `svelte-add` CLIs. Thank you to [J](https://github.com/babichjacob) for starting the community-led `svelte-add` project and to the [`svelte-add` contributors](https://github.com/svelte-add/svelte-add/graphs/contributors).
 
 ## License
 
-Copyright 2013-2016 Christopher Brown. [MIT Licensed](http://chbrown.github.io/licenses/MIT/#2013-2016).
+[MIT](../../LICENSE).