-
-
Notifications
You must be signed in to change notification settings - Fork 448
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
1,215 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,179 @@ | ||
<!-- | ||
@license Apache-2.0 | ||
Copyright (c) 2023 The Stdlib Authors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
--> | ||
|
||
# headercase | ||
|
||
> Convert a string to HTTP header case. | ||
<!-- Package usage documentation. --> | ||
|
||
<section class="usage"> | ||
|
||
## Usage | ||
|
||
```javascript | ||
var headercase = require( '@stdlib/string/headercase' ); | ||
``` | ||
|
||
#### headercase( str ) | ||
|
||
Converts a string to HTTP header case. | ||
|
||
```javascript | ||
var out = headercase( 'foo bar' ); | ||
// returns 'Foo-Bar' | ||
|
||
out = headercase( 'IS_MOBILE' ); | ||
// returns 'Is-Mobile' | ||
|
||
out = headercase( 'Hello World!' ); | ||
// returns 'Hello-World' | ||
|
||
out = headercase( '--foo-bar--' ); | ||
// returns 'Foo-Bar' | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<!-- Package usage examples. --> | ||
|
||
<section class="examples"> | ||
|
||
## Examples | ||
|
||
```javascript | ||
var headercase = require( '@stdlib/string/headercase' ); | ||
|
||
var str = 'Hello World!'; | ||
var out = headercase( str ); | ||
// returns 'Hello-World' | ||
|
||
str = 'HELLO WORLD!'; | ||
out = headercase( str ); | ||
// returns 'Hello-World' | ||
|
||
str = 'To be, or not to be: that is the question.'; | ||
out = headercase( str ); | ||
// returns 'To-Be-Or-Not-To-Be-That-Is-The-Question' | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
* * * | ||
|
||
<section class="cli"> | ||
|
||
## CLI | ||
|
||
<section class="usage"> | ||
|
||
### Usage | ||
|
||
```text | ||
Usage: headercase [options] [<string>] | ||
Options: | ||
-h, --help Print this message. | ||
-V, --version Print the package version. | ||
--split sep Delimiter for stdin data. Default: '/\\r?\\n/'. | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.usage --> | ||
|
||
<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="notes"> | ||
|
||
### Notes | ||
|
||
- If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes. | ||
|
||
```bash | ||
# Not escaped... | ||
$ echo -n $'beep\nfoo_bar' | headercase --split /\r?\n/ | ||
|
||
# Escaped... | ||
$ echo -n $'beep\nfoo_bar' | headercase --split /\\r?\\n/ | ||
``` | ||
|
||
- The implementation ignores trailing delimiters. | ||
|
||
</section> | ||
|
||
<!-- /.notes --> | ||
|
||
<section class="examples"> | ||
|
||
### Examples | ||
|
||
```bash | ||
$ headercase 'hello world!' | ||
Hello-World | ||
``` | ||
|
||
To use as a [standard stream][standard-streams], | ||
|
||
```bash | ||
$ echo -n 'beEp booP' | headercase | ||
Beep-Boop | ||
``` | ||
|
||
By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option. | ||
|
||
```bash | ||
$ echo -n 'beep\tfoo_bar' | headercase --split '\t' | ||
Beep | ||
Foo-Bar | ||
``` | ||
|
||
</section> | ||
|
||
<!-- /.examples --> | ||
|
||
</section> | ||
|
||
<!-- /.cli --> | ||
|
||
<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --> | ||
|
||
<section class="related"> | ||
|
||
</section> | ||
|
||
<!-- /.related --> | ||
|
||
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> | ||
|
||
<section class="links"> | ||
|
||
[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams | ||
|
||
[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions | ||
|
||
</section> | ||
|
||
<!-- /.links --> |
55 changes: 55 additions & 0 deletions
55
lib/node_modules/@stdlib/string/headercase/benchmark/benchmark.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2023 The Stdlib Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
// MODULES // | ||
|
||
var bench = require( '@stdlib/bench' ); | ||
var isString = require( '@stdlib/assert/is-string' ).isPrimitive; | ||
var pkg = require( './../package.json' ).name; | ||
var headercase = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
bench( pkg, function benchmark( b ) { | ||
var values; | ||
var out; | ||
var i; | ||
|
||
values = [ | ||
'beep boop', | ||
'foo bar', | ||
'xyz abc' | ||
]; | ||
|
||
b.tic(); | ||
for ( i = 0; i < b.iterations; i++ ) { | ||
out = headercase( values[ i%values.length ] ); | ||
if ( typeof out !== 'string' ) { | ||
b.fail( 'should return a string' ); | ||
} | ||
} | ||
b.toc(); | ||
if ( !isString( out ) ) { | ||
b.fail( 'should return a string' ); | ||
} | ||
b.pass( 'benchmark finished' ); | ||
b.end(); | ||
}); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,108 @@ | ||
#!/usr/bin/env node | ||
|
||
/** | ||
* @license Apache-2.0 | ||
* | ||
* Copyright (c) 2023 The Stdlib Authors. | ||
* | ||
* Licensed under the Apache License, Version 2.0 (the "License"); | ||
* you may not use this file except in compliance with the License. | ||
* You may obtain a copy of the License at | ||
* | ||
* http://www.apache.org/licenses/LICENSE-2.0 | ||
* | ||
* Unless required by applicable law or agreed to in writing, software | ||
* distributed under the License is distributed on an "AS IS" BASIS, | ||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
* See the License for the specific language governing permissions and | ||
* limitations under the License. | ||
*/ | ||
|
||
'use strict'; | ||
|
||
// MODULES // | ||
|
||
var resolve = require( 'path' ).resolve; | ||
var readFileSync = require( '@stdlib/fs/read-file' ).sync; | ||
var CLI = require( '@stdlib/cli/ctor' ); | ||
var stdin = require( '@stdlib/process/read-stdin' ); | ||
var stdinStream = require( '@stdlib/streams/node/stdin' ); | ||
var RE_EOL = require( '@stdlib/regexp/eol' ).REGEXP; | ||
var isRegExpString = require( '@stdlib/assert/is-regexp-string' ); | ||
var reFromString = require( '@stdlib/utils/regexp-from-string' ); | ||
var headercase = require( './../lib' ); | ||
|
||
|
||
// MAIN // | ||
|
||
/** | ||
* Main execution sequence. | ||
* | ||
* @private | ||
* @returns {void} | ||
*/ | ||
function main() { | ||
var split; | ||
var flags; | ||
var args; | ||
var cli; | ||
|
||
// Create a command-line interface: | ||
cli = new CLI({ | ||
'pkg': require( './../package.json' ), | ||
'options': require( './../etc/cli_opts.json' ), | ||
'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), { | ||
'encoding': 'utf8' | ||
}) | ||
}); | ||
|
||
// Get any provided command-line options: | ||
flags = cli.flags(); | ||
if ( flags.help || flags.version ) { | ||
return; | ||
} | ||
|
||
// Get any provided command-line arguments: | ||
args = cli.args(); | ||
|
||
// Check if we are receiving data from `stdin`... | ||
if ( !stdinStream.isTTY ) { | ||
if ( flags.split ) { | ||
if ( !isRegExpString( flags.split ) ) { | ||
flags.split = '/'+flags.split+'/'; | ||
} | ||
split = reFromString( flags.split ); | ||
} else { | ||
split = RE_EOL; | ||
} | ||
return stdin( onRead ); | ||
} | ||
console.log( headercase( args[ 0 ] ) ); // eslint-disable-line no-console | ||
|
||
/** | ||
* Callback invoked upon reading from `stdin`. | ||
* | ||
* @private | ||
* @param {(Error|null)} error - error object | ||
* @param {Buffer} data - data | ||
* @returns {void} | ||
*/ | ||
function onRead( error, data ) { | ||
var lines; | ||
var i; | ||
if ( error ) { | ||
return cli.error( error ); | ||
} | ||
lines = data.toString().split( split ); | ||
|
||
// Remove any trailing separators (e.g., trailing newline)... | ||
if ( lines[ lines.length-1 ] === '' ) { | ||
lines.pop(); | ||
} | ||
for ( i = 0; i < lines.length; i++ ) { | ||
console.log( headercase( lines[ i ] ) ); // eslint-disable-line no-console | ||
} | ||
} | ||
} | ||
|
||
main(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
|
||
{{alias}}( str ) | ||
Converts a string to HTTP header case. | ||
|
||
Parameters | ||
---------- | ||
str: string | ||
Input string. | ||
|
||
Returns | ||
------- | ||
out: string | ||
HTTP header-cased string. | ||
|
||
Examples | ||
-------- | ||
> var out = {{alias}}( 'Hello World!' ) | ||
'Hello-World' | ||
> out = {{alias}}( 'beep boop' ) | ||
'Beep-Boop' | ||
|
||
See Also | ||
-------- |
Oops, something went wrong.