Skip to content

Commit 5784b0f

Browse files
author
Julius Celik
committedJan 15, 2020
Initial commit
·
v2.0.10v1.0.0-alpha.1
0 parents  commit 5784b0f

20 files changed

+4177
-0
lines changed
 

Diff for: ‎.editorconfig

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 2
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
10+
[*.md]
11+
trim_trailing_whitespace = false

Diff for: ‎.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/lib

Diff for: ‎.eslintrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": ["oclif", "oclif-typescript"]
3+
}

Diff for: ‎.gitignore

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
*-debug.log
2+
*-error.log
3+
/.nyc_output
4+
/dist
5+
/lib
6+
/tmp
7+
/yarn.lock
8+
node_modules

Diff for: ‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

Diff for: ‎README.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
@digitalroute/plutt
2+
===================
3+
4+
5+
6+
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
7+
[![Version](https://img.shields.io/npm/v/@digitalroute/plutt.svg)](https://npmjs.org/package/@digitalroute/plutt)
8+
[![Downloads/week](https://img.shields.io/npm/dw/@digitalroute/plutt.svg)](https://npmjs.org/package/@digitalroute/plutt)
9+
[![License](https://img.shields.io/npm/l/@digitalroute/plutt.svg)](https://github.com/digitalroute/plutt/blob/master/package.json)
10+
11+
<!-- toc -->
12+
* [Usage](#usage)
13+
* [Commands](#commands)
14+
<!-- tocstop -->
15+
# Usage
16+
<!-- usage -->
17+
```sh-session
18+
$ npm install -g @digitalroute/plutt
19+
$ plutt COMMAND
20+
running command...
21+
$ plutt (-v|--version|version)
22+
@digitalroute/plutt/0.0.0 darwin-x64 node-v12.14.1
23+
$ plutt --help [COMMAND]
24+
USAGE
25+
$ plutt COMMAND
26+
...
27+
```
28+
<!-- usagestop -->
29+
# Commands
30+
<!-- commands -->
31+
* [`plutt hello [FILE]`](#plutt-hello-file)
32+
* [`plutt help [COMMAND]`](#plutt-help-command)
33+
34+
## `plutt hello [FILE]`
35+
36+
describe the command here
37+
38+
```
39+
USAGE
40+
$ plutt hello [FILE]
41+
42+
OPTIONS
43+
-f, --force
44+
-h, --help show CLI help
45+
-n, --name=name name to print
46+
47+
EXAMPLE
48+
$ plutt hello
49+
hello world from ./src/hello.ts!
50+
```
51+
52+
_See code: [src/commands/hello.ts](https://github.com/digitalroute/plutt/blob/v0.0.0/src/commands/hello.ts)_
53+
54+
## `plutt help [COMMAND]`
55+
56+
display help for plutt
57+
58+
```
59+
USAGE
60+
$ plutt help [COMMAND]
61+
62+
ARGUMENTS
63+
COMMAND command to show help for
64+
65+
OPTIONS
66+
--all see all commands in CLI
67+
```
68+
69+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v2.2.3/src/commands/help.ts)_
70+
<!-- commandsstop -->

Diff for: ‎bin/run

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
#!/usr/bin/env node
2+
3+
require('@oclif/command').run()
4+
.then(require('@oclif/command/flush'))
5+
.catch(require('@oclif/errors/handle'))

Diff for: ‎bin/run.cmd

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
@echo off
2+
3+
node "%~dp0\run" %*

Diff for: ‎package-lock.json

+3,658
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: ‎package.json

+64
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
{
2+
"name": "@digitalroute/plutt",
3+
"version": "0.0.0",
4+
"author": "Julius Celik",
5+
"bin": {
6+
"plutt": "./bin/run"
7+
},
8+
"bugs": "https://github.com/digitalroute/plutt/issues",
9+
"dependencies": {
10+
"@oclif/command": "^1.5.19",
11+
"@oclif/config": "^1.13.3",
12+
"@oclif/plugin-help": "^2.2.3",
13+
"fs-extra": "^8.1.0",
14+
"tslib": "^1.10.0"
15+
},
16+
"devDependencies": {
17+
"@oclif/dev-cli": "^1.22.2",
18+
"@oclif/test": "^1.2.5",
19+
"@types/chai": "^4.2.7",
20+
"@types/fs-extra": "^8.0.1",
21+
"@types/mocha": "^5.2.7",
22+
"@types/node": "^10.17.13",
23+
"chai": "^4.2.0",
24+
"eslint": "^5.16.0",
25+
"eslint-config-oclif": "^3.1.0",
26+
"eslint-config-oclif-typescript": "^0.1.0",
27+
"globby": "^10.0.2",
28+
"mocha": "^5.2.0",
29+
"nyc": "^14.1.1",
30+
"ts-node": "^8.6.2",
31+
"typescript": "^3.7.4"
32+
},
33+
"engines": {
34+
"node": ">=8.0.0"
35+
},
36+
"files": [
37+
"/bin",
38+
"/lib",
39+
"/npm-shrinkwrap.json",
40+
"/oclif.manifest.json"
41+
],
42+
"homepage": "https://github.com/digitalroute/plutt",
43+
"keywords": [
44+
"oclif"
45+
],
46+
"license": "UNLICENSED",
47+
"main": "lib/index.js",
48+
"oclif": {
49+
"commands": "./lib/commands",
50+
"bin": "plutt",
51+
"plugins": [
52+
"@oclif/plugin-help"
53+
]
54+
},
55+
"repository": "digitalroute/plutt",
56+
"scripts": {
57+
"postpack": "rm -f oclif.manifest.json",
58+
"posttest": "eslint . --ext .ts --config .eslintrc",
59+
"prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
60+
"test": "nyc --extension .ts mocha --forbid-only \"test/**/*.test.ts\"",
61+
"version": "oclif-dev readme && git add README.md"
62+
},
63+
"types": "lib/index.d.ts"
64+
}

Diff for: ‎prettier.config.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
singleQuote: true
3+
};

Diff for: ‎src/commands/build-child.ts

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
import { Command } from '@oclif/command';
2+
import { existsSync, rmdir } from 'fs';
3+
import { join } from 'path';
4+
import chalk from 'chalk';
5+
import { remove, copy } from 'fs-extra';
6+
7+
export default class BuildChild extends Command {
8+
static description = 'describe the command here';
9+
10+
static examples = [
11+
`$ plutt hello
12+
hello world from ./src/hello.ts!
13+
`
14+
];
15+
16+
async run() {
17+
// 1. Check that src and src/index exists
18+
const projectDir = process.cwd();
19+
const srcDir = join(projectDir, 'src');
20+
const srcPath = join(srcDir, 'index.js');
21+
22+
if (!existsSync(srcDir)) {
23+
this.error(`Can not build plutt. There does not exist a src directory.
24+
25+
Looking in ${chalk.magenta(srcPath)}`);
26+
}
27+
28+
if (!existsSync(srcPath)) {
29+
this.error(`Can not build plutt. There does not exist an index file.
30+
31+
Looking in ${chalk.magenta(srcPath)}`);
32+
}
33+
34+
// 2. Copy files to .plutt/
35+
const tempDir = join(projectDir, '.plutt');
36+
await remove(tempDir);
37+
await copy(srcDir, tempDir);
38+
39+
// 3. Add __index.js to .plutt/
40+
const childWrapperPath = join(
41+
__dirname,
42+
'..',
43+
'..',
44+
'templates',
45+
'child.js'
46+
);
47+
const childWrapperDest = join(tempDir, '__index.js');
48+
await copy(childWrapperPath, childWrapperDest);
49+
50+
// 4. Compile with webpack
51+
}
52+
}

Diff for: ‎src/commands/hello.ts

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
import { Command, flags } from "@oclif/command";
2+
3+
export default class Hello extends Command {
4+
static description = "describe the command here";
5+
6+
static examples = [
7+
`$ plutt hello
8+
hello world from ./src/hello.ts!
9+
`
10+
];
11+
12+
static flags = {
13+
help: flags.help({ char: "h" }),
14+
// flag with a value (-n, --name=VALUE)
15+
name: flags.string({ char: "n", description: "name to print" }),
16+
// flag with no value (-f, --force)
17+
force: flags.boolean({ char: "f" })
18+
};
19+
20+
static args = [{ name: "file" }];
21+
22+
async run() {
23+
const { args, flags } = this.parse(Hello);
24+
25+
const name = flags.name || "world";
26+
this.log(`hello ${name} from ./src/commands/hello.ts`);
27+
if (args.file && flags.force) {
28+
this.log(`you input --force and --file: ${args.file}`);
29+
}
30+
}
31+
}

Diff for: ‎src/index.ts

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
export {run} from '@oclif/command'

Diff for: ‎templates/child.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
import app from '.';
2+
3+
export default mountElement => {
4+
ReactDOM.render(app, mountElement);
5+
};

Diff for: ‎templates/index.html

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<meta http-equiv="X-UA-Compatible" content="ie=edge" />
7+
<title>Document</title>
8+
</head>
9+
<body>
10+
<script>
11+
import('./child.js').then(mod => {
12+
mod.default();
13+
});
14+
</script>
15+
</body>
16+
</html>

Diff for: ‎test/commands/hello.test.ts

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
import {expect, test} from '@oclif/test'
2+
3+
describe('hello', () => {
4+
test
5+
.stdout()
6+
.command(['hello'])
7+
.it('runs hello', ctx => {
8+
expect(ctx.stdout).to.contain('hello world')
9+
})
10+
11+
test
12+
.stdout()
13+
.command(['hello', '--name', 'jeff'])
14+
.it('runs hello --name jeff', ctx => {
15+
expect(ctx.stdout).to.contain('hello jeff')
16+
})
17+
})

Diff for: ‎test/mocha.opts

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
--require ts-node/register
2+
--watch-extensions ts
3+
--recursive
4+
--reporter spec
5+
--timeout 5000

Diff for: ‎test/tsconfig.json

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"extends": "../tsconfig",
3+
"compilerOptions": {
4+
"noEmit": true
5+
},
6+
"references": [
7+
{"path": ".."}
8+
]
9+
}

Diff for: ‎tsconfig.json

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
{
2+
"compilerOptions": {
3+
"declaration": true,
4+
"importHelpers": true,
5+
"module": "commonjs",
6+
"outDir": "lib",
7+
"rootDir": "src",
8+
"strict": true,
9+
"target": "es2017"
10+
},
11+
"include": [
12+
"src/**/*"
13+
]
14+
}

0 commit comments

Comments
 (0)
Please sign in to comment.