Skip to content

Commit

Permalink
initialise package
Browse files Browse the repository at this point in the history
  • Loading branch information
zavr-1 committed Feb 6, 2020
1 parent 9882fb0 commit 670042a
Show file tree
Hide file tree
Showing 62 changed files with 786 additions and 1,152 deletions.
16 changes: 6 additions & 10 deletions .alamoderc.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,17 @@
}
}
},
"test-compile": {
"import": {
"replacement": {
"from": "^((../)+)src$",
"to": "$1compile"
}
}
},
"build": {
"import": {
"stdlib": {
"path": "stdlib",
"packages": ["argufy", "indicatrix", "usually", "erte"]
"packages": [
"erte"
]
},
"alamodeModules": ["argufy", "indicatrix", "usually", "erte"]
"alamodeModules": [
"erte"
]
}
}
}
Expand Down
8 changes: 4 additions & 4 deletions .documentary/index.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
* The footer for documentation.
*/
export const footer = () => {
const alt = '{{ org }}'
const src = 'https://avatars3.githubusercontent.com/u/38815725?v=4&s=100'
const href = '{{ website }}'
const org = '{{ trademark }}'
const alt = 'art-deco'
const src = 'https://avatars2.githubusercontent.com/u/57873407?v=4&s=100'
const href = 'https://www.artd.eco'
const org = 'Art Deco™'
const year = new Date().getFullYear()
return [
(<table>
Expand Down
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,3 @@ typings/

.documentary/cache

# start template
.gitmodules
# end template
2 changes: 1 addition & 1 deletion .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
"name": "Launch Zoroaster",
"program": "${workspaceFolder}/node_modules/.bin/zoroaster",
"env": {
// "NODE_DEBUG": "my-new-package",
// "NODE_DEBUG": "@artdeco/typescript",
},
"console": "integratedTerminal",
"args": [
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## {{ create_date }}
## 6 February 2020

### 0.0.0-pre

- Create `{{ package-name }}` with _[`NodeTools`](https://art-deco.github.io/nodetools)_.
- Create `@artdeco/typescript` with _[`NodeTools`](https://art-deco.github.io/nodetools)_.
661 changes: 661 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

88 changes: 14 additions & 74 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# my-new-package
# @artdeco/typescript

[![npm version](https://badge.fury.io/js/my-new-package.svg)](https://www.npmjs.com/package/my-new-package)
[![npm version](https://badge.fury.io/js/@artdeco/typescript.svg)](https://www.npmjs.com/package/@artdeco/typescript)

`my-new-package` is {{ description }}
`@artdeco/typescript` is TypeScript bug.

```sh
yarn add my-new-package
yarn add @artdeco/typescript
```

## Table Of Contents

- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`async myNewPackage(config: !Config): string`](#async-mynewpackageconfig-config-string)
- [`async typescript(config: !Config): string`](#async-mynewpackageconfig-config-string)
* [`Config`](#type-config)
- [CLI](#cli)
- [Copyright & License](#copyright--license)
Expand All @@ -26,15 +26,15 @@ yarn add my-new-package
The package is available by importing its default function:

```js
import myNewPackage from 'my-new-package'
import typescript from '@artdeco/typescript'
```

<p align="center"><a href="#table-of-contents">
<img src="/.documentary/section-breaks/1.svg?sanitize=true">
</a></p>

## <code>async <ins>myNewPackage</ins>(</code><sub><br/>&nbsp;&nbsp;`config: !Config,`<br/></sub><code>): <i>string</i></code>
{{ description }}
## <code>async <ins>typescript</ins>(</code><sub><br/>&nbsp;&nbsp;`config: !Config,`<br/></sub><code>): <i>string</i></code>
TypeScript bug.

- <kbd><strong>config*</strong></kbd> <em><code><a href="#type-config" title="Options for the program.">!Config</a></code></em>: The config.

Expand All @@ -47,92 +47,32 @@ __<a name="type-config">`Config`</a>__: Options for the program.
| text | <em>string</em> | A text to return. | - |

```js
import myNewPackage from 'my-new-package'
import typescript from '@artdeco/typescript'

(async () => {
const res = await myNewPackage({
const res = await typescript({
text: 'example',
})
console.log(res)
})()
```
```
my-new-package called with example
@artdeco/typescript called with example
example
```

<p align="center"><a href="#table-of-contents">
<img src="/.documentary/section-breaks/2.svg?sanitize=true">
</a></p>

## CLI

The package can also be used from the CLI.

<table>
<thead>
<tr>
<th>Argument</th>
<th>Short</th>
<th>Description</th>
</tr>
</thead>
<tr>
<td>input</td>
<td></td>
<td>The path to the input file.</td>
</tr>
<tr>
<td>--output</td>
<td>-o</td>
<td>Where to save the output. By default prints to stdout. Default <code>-</code>.</td>
</tr>
<tr>
<td>--init</td>
<td>-i</td>
<td>Initialise in the current folder.</td>
</tr>
<tr>
<td>--help</td>
<td>-h</td>
<td>Print the help information and exit.</td>
</tr>
<tr>
<td>--version</td>
<td>-v</td>
<td>Show the version's number and exit.</td>
</tr>
</table>

```
{{ description }}
mnp input [-o output] [-ihv]
input The path to the input file.
--output, -o Where to save the output. By default prints to stdout.
Default: -.
--init, -i Initialise in the current folder.
--help, -h Print the help information and exit.
--version, -v Show the version's number and exit.
Example:
mnp example.txt -o out.txt
```

<p align="center"><a href="#table-of-contents">
<img src="/.documentary/section-breaks/3.svg?sanitize=true">
</a></p>

## Copyright & License

{{ license_name }}
GNU Affero General Public License v3.0

<table>
<tr>
<td><img src="https://avatars3.githubusercontent.com/u/38815725?v=4&amp;s=100" alt="{{ org }}"></td>
<td>© <a href="{{ website }}">{{ trademark }}</a> 2020</td>
<td><img src="https://avatars3.githubusercontent.com/u/38815725?v=4&amp;s=100" alt="art-deco"></td>
<td>© <a href="https://www.artd.eco">Art Deco™</a> 2020</td>
</tr>
</table>

Expand Down
8 changes: 0 additions & 8 deletions build/bin/commands/init.js

This file was deleted.

67 changes: 0 additions & 67 deletions build/bin/get-args.js

This file was deleted.

3 changes: 0 additions & 3 deletions build/bin/index.js

This file was deleted.

39 changes: 0 additions & 39 deletions build/bin/mnp.js

This file was deleted.

6 changes: 0 additions & 6 deletions build/depack.js

This file was deleted.

28 changes: 0 additions & 28 deletions build/index-build.js

This file was deleted.

Loading

0 comments on commit 670042a

Please sign in to comment.