Compare commits

...

164 Commits

Author SHA1 Message Date
ba16c60168 remove database snippet 2020-07-04 16:49:16 +02:00
46be34c4b0 add copyright 2020-06-28 17:02:46 +02:00
3e773b5327 fix 2020-06-28 16:55:44 +02:00
146c9b661f initial menu design, simpler patch serialization 2020-06-28 14:51:37 +02:00
214b113865 complete feature 2020-06-27 19:50:34 +02:00
336edb84b1 fix 2020-06-27 19:42:46 +02:00
d7d30fd417 carry previous date string 2020-06-27 19:36:46 +02:00
6ff99c827d update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.1.14 ==> 1.1.16 minor
@sapphirecode/standard: 1.1.7 ==> 1.1.8 minor
@types/node: 14.0.13 ==> 14.0.14 minor
eslint: 7.3.0 ==> 7.3.1 minor
2020-06-24 13:01:13 +02:00
e3ddb9a069 update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.1.13 ==> 1.1.14 minor
@sapphirecode/standard: 1.1.6 ==> 1.1.7 minor
eslint: 7.2.0 ==> 7.3.0 minor
2020-06-22 08:31:34 +02:00
1519290c1d update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.1.12 ==> 1.1.13 minor
2020-06-19 13:19:13 +02:00
e617141a5c update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.1.11 ==> 1.1.12 minor
@sapphirecode/standard: 1.1.5 ==> 1.1.6 minor
@types/node: 14.0.10 ==> 14.0.13 minor
eslint: 7.1.0 ==> 7.2.0 minor
typescript: 3.9.3 ==> 3.9.5 minor
2020-06-11 20:41:27 +02:00
830c82d69d update-scanner: automatic update
@sapphirecode/standard: 1.1.4 ==> 1.1.5 minor
@types/node: 14.0.9 ==> 14.0.10 minor
fs-extra: 9.0.0 ==> 9.0.1 minor
2020-06-04 11:44:37 +02:00
aba411a17a update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.1.10 ==> 1.1.11 minor
@sapphirecode/standard: 1.1.3 ==> 1.1.4 minor
@types/node: 14.0.5 ==> 14.0.9 minor
2020-06-02 08:58:26 +02:00
92cb9d5c21 update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.1.9 ==> 1.1.10 minor
2020-05-28 08:57:02 +02:00
32deb35fec fix 2020-05-24 19:43:13 +02:00
cd7041c2e1 update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.1.7 ==> 1.1.9 minor
@sapphirecode/standard: 1.0.28 ==> 1.1.3 minor
@types/fs-extra: 9.0.0 ==> 9.0.1 minor
@types/node: 14.0.1 ==> 14.0.5 minor
eslint: 7.0.0 ==> 7.1.0 minor
typescript: 3.9.2 ==> 3.9.3 minor
2020-05-23 18:33:05 +02:00
97d4756eb1 update 2020-05-17 19:55:04 +02:00
b1a53a3ad1 update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.0.45 ==> 1.1.7 minor
@sapphirecode/standard: 1.0.18 ==> 1.0.28 minor
@types/fs-extra: 8.1.0 ==> 9.0.0 major
@types/node: 13.13.6 ==> 14.0.1 major
eslint: 6.8.0 ==> 7.0.0 major
2020-05-17 19:49:50 +02:00
c54fba0483 fix 2020-05-17 16:12:00 +02:00
c68be00e16 update jenkins.js 2020-05-15 13:17:34 +02:00
08ec8d9182 fix 2020-05-13 21:12:29 +02:00
190f20c7b9 fix readme 2020-05-13 21:09:03 +02:00
d55b752958 remove link to package quality, as the site seems to be unmaintained 2020-05-13 21:06:20 +02:00
b87c5bf2f1 adapt jenkins.js 2020-05-13 16:08:05 +02:00
9a0a4a4201 add version to readme 2020-05-13 11:39:46 +02:00
8e3a19221d update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.0.44 ==> 1.0.45 minor
@sapphirecode/standard: 1.0.14 ==> 1.0.18 minor
@types/node: 13.13.5 ==> 14.0.1 major
eslint: 6.8.0 ==> 7.0.0 major
typescript: 3.8.3 ==> 3.9.2 minor
2020-05-13 11:15:26 +02:00
a6da0f6836 description without blockquote 2020-05-11 12:21:18 +02:00
21411e8684 fixing badge again 2020-05-11 12:20:46 +02:00
20e66788c2 fix 2020-05-11 12:18:39 +02:00
f4b7366d49 readme 2020-05-11 12:12:28 +02:00
4e76cf3d5c disable wip snippets 2020-05-11 12:01:39 +02:00
f0a67a5d84 fix 2020-05-11 11:34:16 +02:00
be004c5e02 readme template 2020-05-11 11:33:34 +02:00
8880a72560 update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.0.43 ==> 1.0.44 minor
@sapphirecode/standard: 1.0.13 ==> 1.0.14 minor
2020-05-08 13:53:34 +02:00
3545ba6a48 fix 2020-05-08 09:58:49 +02:00
6b0b40a292 update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.0.41 ==> 1.0.43 minor
2020-05-07 19:35:02 +02:00
c25b352041 fixes 2020-05-07 18:40:35 +02:00
ab66113c89 update-scanner: automatic update
@sapphirecode/eslint-config-ts: 1.0.38 ==> 1.0.41 minor
@sapphirecode/standard: 1.0.12 ==> 1.0.13 minor
2020-05-07 10:43:39 +02:00
3a5cc47424 update-scanner: automatic update
@sapphirecode/standard: 1.0.11 ==> 1.0.12 minor
2020-05-06 10:10:07 +02:00
3bc5d16f8a update 2020-05-06 08:36:48 +02:00
83b5cd054b fix 2020-05-06 07:50:58 +02:00
cb169f9242 fix 2020-05-06 07:45:16 +02:00
5ec439cd1e fix 2020-05-06 07:33:11 +02:00
048dee838a fix publish 2020-05-05 19:50:17 +02:00
1b182c9932 move to @sapphirecode scope 2020-05-05 19:23:52 +02:00
476111c1b6 update-scanner: automatic update
@scode/standard: 1.0.7 ==> 1.0.8 minor
2020-05-04 21:52:22 +02:00
e8b22b84ca update-scanner: automatic update
@scode/eslint-config-ts: 1.0.29 ==> 1.0.31 minor
@scode/standard: 1.0.4 ==> 1.0.7 minor
2020-05-04 21:20:18 +02:00
ebff7dc7f4 update 2020-05-04 12:32:17 +02:00
c9fd021634 fixes, option for no tests 2020-05-04 12:31:38 +02:00
91869b3183 standardization 2020-05-04 12:23:06 +02:00
a7180f9e50 update-scanner: automatic update
@scode/eslint-config-ts: 1.0.27 ==> 1.0.29 minor
2020-05-03 18:35:14 +02:00
bbdfaf1791 update-scanner: automatic update
@scode/eslint-config-ts: 1.0.26 ==> 1.0.27 minor
2020-05-02 17:18:41 +02:00
6e48707ec2 update-scanner: automatic update
@scode/eslint-config-ts: 1.0.23 ==> 1.0.26 minor
2020-04-28 07:43:37 +02:00
0d1b3aac2e fix 2020-04-27 13:54:10 +02:00
9663fc3579 update-scanner: automatic update
@scode/eslint-config-ts: 1.0.22 ==> 1.0.23 minor
@types/node: 13.13.2 ==> 13.13.4 minor
2020-04-27 13:04:23 +02:00
d38cfb041c log error instead of promise rejection 2020-04-27 10:18:12 +02:00
deacaa76a1 ignore d.ts files 2020-04-27 10:12:51 +02:00
650cdf7476 fix 2020-04-27 08:51:53 +02:00
0edf59ba24 fix 2020-04-26 12:07:23 +02:00
cae2b2ad75 fix 2020-04-26 12:04:10 +02:00
b69e6a36c3 license in file + package json 2020-04-26 11:57:42 +02:00
cd7c757daf tsc on test when typescript on 2020-04-26 11:57:32 +02:00
a6e607334c remove unnecessary file 2020-04-26 11:45:22 +02:00
f95226c7f0 remove trailing space 2020-04-24 12:08:30 +02:00
45b64b3aca fix 2020-04-24 10:19:02 +02:00
32410bab93 output declarations by default 2020-04-23 18:09:42 +02:00
17bf48d7cc fix 2020-04-23 17:58:04 +02:00
8bc26b384e fixes 2020-04-23 17:51:19 +02:00
fee3f55300 fix 2020-04-23 17:44:14 +02:00
4dcfde8316 fixes 2020-04-23 17:39:18 +02:00
592b02226d update yarn.lock 2020-04-23 17:38:12 +02:00
f8f7c5d91c Merge branch 'dev'
# Conflicts:
#	yarn.lock
2020-04-23 17:37:05 +02:00
3ea7163e17 add eslintrc for ts 2020-04-23 17:30:12 +02:00
7a563862af don't initialize index files 2020-04-23 17:07:54 +02:00
5a6c874425 add compile script to typescript 2020-04-23 16:38:29 +02:00
3160ccd49c add typescript support to node snippet 2020-04-23 16:19:31 +02:00
d0c3e333a0 update-scanner: automatic update
@scode/eslint-config: 2.0.10 ==> 2.0.11 minor
2020-04-21 11:19:00 +02:00
b7706f9a42 implementing patches 2020-04-19 18:49:07 +02:00
858d778039 database structure 2020-04-18 20:43:02 +02:00
dde41c085e fixes 2020-04-18 19:00:27 +02:00
168fc577d9 fix 2020-04-18 17:45:39 +02:00
c0c2881020 fixes 2020-04-18 17:43:13 +02:00
f383ed0ce4 complete other snippets 2020-04-18 17:24:41 +02:00
3c44614298 fix 2020-04-16 08:05:46 +02:00
fa5c631d23 don't ask for save if loaded from config 2020-04-16 08:04:58 +02:00
1feda9d44f fix 2020-04-16 08:02:35 +02:00
6a525d8120 dialog fix 2020-04-16 08:00:53 +02:00
05d4839dea license config, copyright notices 2020-04-16 07:45:48 +02:00
2094287af8 save settings 2020-04-16 07:42:32 +02:00
90515c1679 fix indent 2020-04-15 20:59:50 +02:00
bc06152359 typescript, interactive 2020-04-15 20:21:00 +02:00
93862eff16 update-scanner: automatic update
@scode/eslint-config: 2.0.7 ==> 2.0.10 minor
2020-04-14 15:41:17 +02:00
7fc4a2abf8 fix lint script 2020-04-14 14:57:01 +02:00
206c1ec571 update-scanner: automatic update
@scode/eslint-config: 2.0.6 ==> 2.0.7 minor
2020-04-09 09:40:29 +02:00
4266a1e29e adapt node template to new rules 2020-04-09 09:11:47 +02:00
28872f5f5d copyright for ts 2020-04-08 19:32:19 +02:00
82af221062 update-scanner: automatic update 2020-04-08 13:08:31 +02:00
2c1d5bffb7 update-scanner: automatic update 2020-04-06 10:02:41 +02:00
3f4474992f fix 2020-04-06 09:43:50 +02:00
dad33228ac update-scanner: automatic update 2020-04-06 08:50:40 +02:00
5722adb75e update-scanner: automatic update 2020-04-06 07:52:55 +02:00
6d7737a74e update-scanner: automatic update 2020-03-30 08:33:30 +02:00
d08ba0332d remove stryker 2020-03-27 09:07:51 +01:00
3a963db136 update-scanner: automatic update 2020-03-26 14:38:48 +01:00
cb9535a5bc formatting 2020-03-25 16:50:05 +01:00
f8416f8b96 fix licensing 2020-03-25 16:45:44 +01:00
814957e9bc fix 2020-03-25 16:44:30 +01:00
0118737289 complete copyright snippet 2020-03-25 15:52:25 +01:00
e55aa6bb08 [no publish] fixes 2020-03-25 13:37:27 +01:00
7a29ad0e92 [no publish] license snippet 2020-03-25 13:14:59 +01:00
28f0eae503 update-scanner: automatic update 2020-03-24 09:30:41 +01:00
5f95292d8e add warning for undefined column types 2020-03-22 19:42:22 +01:00
2d0aeb53cd update 2020-03-20 08:27:53 +01:00
4d54519ccc update-scanner: automatic update 2020-03-19 07:08:18 +01:00
9eac508b1c add 'no test' flag 2020-03-14 14:27:29 +01:00
323f12a260 formatting 2020-03-14 14:26:46 +01:00
02f7884f8c add stryker 2020-03-14 14:05:09 +01:00
cc53f2211d update-scanner: automatic update 2020-03-12 09:38:04 +01:00
ca5ef064c7 update-scanner: automatic update 2020-03-12 09:33:43 +01:00
8a6eda9d89 Revert "add clean workspace to jenkins templates"
This reverts commit a89fd1e4d9.
2020-03-10 08:07:02 +01:00
a89fd1e4d9 add clean workspace to jenkins templates 2020-03-10 08:03:21 +01:00
91ae8d0061 fix migration naming 2020-03-09 10:11:38 +01:00
7876b75afa fix bulk insert in csv template 2020-03-09 09:49:35 +01:00
0a3b86e9ca add timestamp type 2020-03-05 08:44:32 +01:00
ea0a2e0f11 update-scanner: automatic update 2020-03-04 21:23:18 +01:00
6a69a8288e don't include coverage reports 2020-03-04 13:23:57 +01:00
b81f7349ef jenkins snippet set ci script 2020-03-04 12:59:16 +01:00
8c47eef18f fix 'no minus in node name' 2020-03-04 11:49:35 +01:00
454f0781df fix typo 2020-03-04 11:34:08 +01:00
20c5faaba7 update-scanner: automatic update 2020-03-03 11:27:30 +01:00
ed11752e6b fix dos format 2020-02-27 08:07:18 +01:00
615171e409 add csv ingress to knex migrations 2020-02-26 20:52:39 +01:00
b79bfdde43 fix scripts 2020-02-21 12:23:21 +01:00
9e17775575 remove test files 2020-02-21 11:46:50 +01:00
285dbf2b5a graphviz to database structure parser 2020-02-21 11:38:53 +01:00
33c34b18f7 [no publish] finish dot parser 2020-02-21 11:29:50 +01:00
74fed4363b [no publish] progressing dot parser 2020-02-20 15:22:33 +01:00
8d665a3576 [no publish] adding db structure interpreter 2020-02-20 11:09:01 +01:00
2b7d6cf307 formatting 2020-02-20 10:57:22 +01:00
b33dd78bd1 formatting 2020-02-20 10:47:38 +01:00
53e0f0569f add test script to node 2020-02-13 08:33:42 +01:00
b0d34e4cd2 fix wrong lint script 2020-02-12 18:09:35 +01:00
04c7140a16 update-scanner: automatic update 2020-02-08 16:22:45 +01:00
7adad73965 fix license 2020-02-08 16:12:53 +01:00
8416bd2f64 update node snippet to use yarn 2020-02-07 08:36:36 +01:00
4fcc3bdb4c update 2020-02-06 18:35:13 +01:00
0df8a43369 apply template jenkins files 2020-02-06 18:26:23 +01:00
bbfed3fbaa remove vue template due to cli already being available 2020-02-06 18:16:14 +01:00
e8cb474527 updating jenkins template 2020-02-06 18:04:52 +01:00
f498d840f3 simplify ci 2020-02-06 17:36:09 +01:00
aa542372cc switch to yarn 2020-02-05 20:16:25 +01:00
b92c6c4144 up 2020-01-30 11:29:27 +01:00
134914ac8c update 2020-01-30 10:57:34 +01:00
e4b2a53344 add requestor template 2020-01-21 09:50:05 +01:00
692f48883c add migration template 2020-01-20 09:12:01 +01:00
bf8b69f6b7 update copyright notices 2020-01-18 21:14:40 +01:00
f16c68a3c0 update license 2020-01-18 14:53:50 +01:00
4186ae490d fix 2020-01-17 19:30:06 +01:00
fa9a4ebba2 fix 2020-01-17 18:10:30 +01:00
8fd02dda35 fix 2020-01-17 17:50:10 +01:00
e6c447a4b6 add vue template 2020-01-16 21:11:59 +01:00
3bd332f52a add jenkins snippet 2020-01-16 20:35:24 +01:00
c59432b53d doc for node 2020-01-15 20:56:47 +01:00
c21b5af22f add node template 2020-01-15 20:44:53 +01:00
35 changed files with 2700 additions and 2684 deletions

2
.eslintignore Normal file
View File

@ -0,0 +1,2 @@
**/*.d.ts
/dist/

View File

@ -1,17 +1,22 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
'use strict';
module.exports = {
env: {
commonjs: true,
es6: true,
node: true
es6: true,
node: true
},
extends: [
'@scode'
],
extends: [ '@sapphirecode' ],
globals: {
Atomics: 'readonly',
Atomics: 'readonly',
SharedArrayBuffer: 'readonly'
},
parserOptions: {
ecmaVersion: 2018
}
}
parserOptions: { ecmaVersion: 2018 }
};

5
.gitignore vendored
View File

@ -1 +1,6 @@
/node_modules/
/dist/
# stryker temp files
.stryker-tmp
*.log

8
.liconfig.json Normal file
View File

@ -0,0 +1,8 @@
{
"has_license": true,
"license": "BSD-3-Clause",
"author": "Timo Hocker",
"company": "SapphireCode",
"email": "timo@scode.ovh",
"software": "Snippeteer"
}

1
.npmrc
View File

@ -1 +0,0 @@
@scode:registry=https://npm.scode.ovh

21
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,21 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"type": "node",
"request": "launch",
"name": "Launch Program",
"skipFiles": [
"<node_internals>/**"
],
"program": "${workspaceFolder}\\index.js",
"outFiles": [
"${workspaceFolder}/**/*.js"
],
"console": "externalTerminal"
}
]
}

18
CHANGELOG.md Normal file
View File

@ -0,0 +1,18 @@
# Changelog
## 1.3.0
Copyright function: carry previous creation date to prevent unnecessary modifications
## 1.2.0
- Fully interactive snippets
- db migration generator removed (new snipped in development)
## 1.1.0
Knex database migration generator
## 1.0.0
initial version

63
Jenkinsfile vendored
View File

@ -1,40 +1,23 @@
pipeline {
agent any
environment {
VERSION = VersionNumber([
versionNumberString:
'${BUILDS_ALL_TIME}',
versionPrefix: '1.0.',
worstResultForIncrement: 'SUCCESS'
])
publish = 0
}
stages {
stage('Setup') {
steps {
echo 'Setting up test environment'
sh 'npm ci'
sh 'nodejs jenkins.js ${VERSION}'
script {
currentBuild.displayName = env.VERSION
}
}
}
}
post {
success {
script {
publish = sh script: "git log -1 | grep '\\[no publish\\]'", returnStatus: true
if (publish != 0) {
echo 'Deploying'
sh 'npm publish'
} else {
echo 'Build successful, Commit not marked for deploying'
currentBuild.result = "UNSTABLE"
}
}
}
}
}
pipeline {
agent any
environment {
VERSION = VersionNumber([
versionNumberString:
'${BUILDS_ALL_TIME}',
versionPrefix: '1.3.',
worstResultForIncrement: 'SUCCESS'
])
}
stages {
stage('Building') {
steps {
script {
currentBuild.displayName = env.VERSION
}
sh 'yarn ci ${VERSION}'
}
}
}
}

638
LICENSE
View File

@ -1,637 +1,11 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (c) <year> <author>. All rights reserved.
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
Everyone is permitted to copy and distribute verbatim copies of this license
document, but changing it is not allowed.
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
Preamble
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
The GNU General Public License is a free, copyleft license for software
and other kinds of works.
The licenses for most software and other practical works are designed to
take away your freedom to share and change the works. By contrast, the
GNU General Public License is intended to guarantee your freedom to share
and change all versions of a program--to make sure it remains free software
for all its users. We, the Free Software Foundation, use the GNU General
Public License for most of our software; it applies also to any other work
released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price.
Our General Public Licenses are designed to make sure that you have the
freedom to distribute copies of free software (and charge for them if
you wish), that you receive source code or can get it if you want it, that
you can change the software or use pieces of it in new free programs,
and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these
rights or asking you to surrender the rights. Therefore, you have certain
responsibilities if you distribute copies of the software, or if you modify it:
responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or
for a fee, you must pass on to the recipients the same freedoms that
you received. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert
copyright on the software, and (2) offer you this License giving you legal
permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains that
there is no warranty for this free software. For both users' and authors' sake,
the GPL requires that modified versions be marked as changed, so that their
problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified
versions of the software inside them, although the manufacturer can do so.
This is fundamentally incompatible with the aim of protecting users' freedom
to change the software. The systematic pattern of such abuse occurs in the
area of products for individuals to use, which is precisely where it is most
unacceptable. Therefore, we have designed this version of the GPL to prohibit
the practice for those products. If such problems arise substantially in other
domains, we stand ready to extend this provision to those domains in future
versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States
should not allow patents to restrict development and use of software on
general-purpose computers, but in those that do, we wish to avoid the special
danger that patents applied to a free program could make it effectively
proprietary. To prevent this, the GPL assures that patents cannot be used
to render the program non-free.
The precise terms and conditions for copying, distribution
and modification follow.
TERMS AND CONDITIONS
0. Definitions.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works,
such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License.
Each licensee is addressed as “you”. “Licensees” and “recipients” may be
individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a
fashion requiring copyright permission, other than the making of an exact copy.
The resulting work is called a “modified version” of the earlier work or a work
“based on” the earlier work.
A “covered work” means either the unmodified Program or a work
based on the Program.
To “propagate” a work means to do anything with it that, without permission,
would make you directly or secondarily liable for infringement under applicable
copyright law, except executing it on a computer or modifying a private copy.
Propagation includes copying, distribution (with or without modification),
making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties
to make or receive copies. Mere interaction with a user through a computer
network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the
extent that it includes a convenient and prominently visible feature that
(1) displays an appropriate copyright notice, and (2) tells the user that
there is no warranty for the work (except to the extent that warranties are
provided), that licensees may convey the work under this License, and how to
view a copy of this License. If the interface presents a list of user commands
or options, such as a menu, a prominent item in the list meets this criterion.
1. Source Code.
The “source code” for a work means the preferred form of the work for making
modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard
defined by a recognized standards body, or, in the case of interfaces specified
for a particular programming language, one that is widely used among
developers working in that language.
The “System Libraries” of an executable work include anything, other than the
work as a whole, that (a) is included in the normal form of packaging a
Major Component, but which is not part of that Major Component, and (b) serves
only to enable use of the work with that Major Component, or to implement a
Standard Interface for which an implementation is available to the public in
source code form. A “Major Component”, in this context, means a major essential
component (kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to produce
the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source
code needed to generate, install, and (for an executable work) run the object
code and to modify the work, including scripts to control those activities.
However, it does not include the work's System Libraries, or general-purpose
tools or generally available free programs which are used unmodified in
performing those activities but which are not part of the work. For example,
Corresponding Source includes interface definition files associated with
source files for the work, and the source code for shared libraries and
dynamically linked subprograms that the work is specifically designed to
require, such as by intimate data communication or control flow between
those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate
automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of copyright
on the Program, and are irrevocable provided the stated conditions are met.
This License explicitly affirms your unlimited permission to run the
unmodified Program. The output from running a covered work is covered by
this License only if the output, given its content, constitutes a covered work.
This License acknowledges your rights of fair use or other equivalent,
as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without
conditions so long as your license otherwise remains in force. You may convey
covered works to others for the sole purpose of having them make modifications
exclusively for you, or provide you with facilities for running those works,
provided that you comply with the terms of this License in conveying all
material for which you do not control copyright. Those thus making or running
the covered works for you must do so exclusively on your behalf, under your
direction and control, on terms that prohibit them from making any copies
of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the
conditions stated below. Sublicensing is not allowed;
section 10 makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological measure
under any applicable law fulfilling obligations under article 11 of the WIPO
copyright treaty adopted on 20 December 1996, or similar laws prohibiting or
restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention is
effected by exercising rights under this License with respect to the covered
work, and you disclaim any intention to limit operation or modification of
the work as a means of enforcing, against the work's users, your or third
parties' legal rights to forbid circumvention of technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you receive it,
in any medium, provided that you conspicuously and appropriately publish on
each copy an appropriate copyright notice; keep intact all notices stating
that this License and any non-permissive terms added in accord with section 7
apply to the code; keep intact all notices of the absence of any warranty;
and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you
may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to produce
it from the Program, in the form of source code under the terms of section 4,
provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified it,
and giving a relevant date.
b) The work must carry prominent notices stating that it is released under
this License and any conditions added under section 7. This requirement
modifies the requirement in section 4 to “keep intact all notices”.
c) You must license the entire work, as a whole, under this License to
anyone who comes into possession of a copy. This License will therefore
apply, along with any applicable section 7 additional terms, to the whole
of the work, and all its parts, regardless of how they are packaged.
This License gives no permission to license the work in any other way,
but it does not invalidate such permission if you
have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your work
need not make them do so.
A compilation of a covered work with other separate and independent works,
which are not by their nature extensions of the covered work, and which are
not combined with it such as to form a larger program, in or on a volume of
a storage or distribution medium, is called an “aggregate” if the compilation
and its resulting copyright are not used to limit the access or legal rights
of the compilation's users beyond what the individual works permit. Inclusion
of a covered work in an aggregate does not cause this License to apply to
the other parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms of
sections 4 and 5, provided that you also convey the machine-readable
Corresponding Source under the terms of this License, in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium customarily
used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a written offer,
valid for at least three years and valid for as long as you offer spare
parts or customer support for that product model, to give anyone who
possesses the object code either (1) a copy of the Corresponding Source
for all the software in the product that is covered by this License, on a
durable physical medium customarily used for software interchange, for a
price no more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the Corresponding Source from
a network server at no charge.
c) Convey individual copies of the object code with a copy of the written
offer to provide the Corresponding Source. This alternative is allowed
only occasionally and noncommercially, and only if you received the object
code with such an offer, in accord with subsection 6b.
d) Convey the object code by offering access from a designated place
(gratis or for a charge), and offer equivalent access to the Corresponding
Source in the same way through the same place at no further charge.
You need not require recipients to copy the Corresponding Source along
with the object code. If the place to copy the object code is a network
server, the Corresponding Source may be on a different server (operated
by you or a third party) that supports equivalent copying facilities,
provided you maintain clear directions next to the object code saying
where to find the Corresponding Source. Regardless of what server hosts
the Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided you
inform other peers where the object code and Corresponding Source of the
work are being offered to the general public at no charge
under subsection 6d.
A separable portion of the object code, whose source code is excluded from the
Corresponding Source as a System Library, need not be included in conveying
the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible
personal property which is normally used for personal, family, or household
purposes, or (2) anything designed or sold for incorporation into a dwelling.
In determining whether a product is a consumer product, doubtful cases shall
be resolved in favor of coverage. For a particular product received by a
particular user, “normally used” refers to a typical or common use of that
class of product, regardless of the status of the particular user or of the
way in which the particular user actually uses, or expects or is expected
to use, the product. A product is a consumer product regardless of whether
the product has substantial commercial, industrial or non-consumer uses,
unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures,
authorization keys, or other information required to install and execute
modified versions of a covered work in that User Product from a modified
version of its Corresponding Source. The information must suffice to ensure
that the continued functioning of the modified object code is in no case
prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as part of
a transaction in which the right of possession and use of the User Product
is transferred to the recipient in perpetuity or for a fixed term (regardless
of how the transaction is characterized), the Corresponding Source conveyed
under this section must be accompanied by the Installation Information.
But this requirement does not apply if neither you nor any third party retains
the ability to install modified object code on the User Product (for example,
the work has been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates for
a work that has been modified or installed by the recipient, or for the User
Product in which it has been modified or installed. Access to a network may
be denied when the modification itself materially and adversely affects the
operation of the network or violates the rules and protocols for
communication across the network.
Corresponding Source conveyed, and Installation Information provided, in
accord with this section must be in a format that is publicly documented
(and with an implementation available to the public in source code form),
and must require no special password or key for unpacking, reading or copying.
7. Additional Terms.
“Additional permissions” are terms that supplement the terms of this License
by making exceptions from one or more of its conditions. Additional permissions
that are applicable to the entire Program shall be treated as though they were
included in this License, to the extent that they are valid under applicable
law. If additional permissions apply only to part of the Program, that part
may be used separately under those permissions, but the entire Program remains
governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any
additional permissions from that copy, or from any part of it. (Additional
permissions may be written to require their own removal in certain cases
when you modify the work.) You may place additional permissions on material,
added by you to a covered work, for which you have or can give
appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a
covered work, you may (if authorized by the copyright holders of that material)
supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the terms
of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or author
attributions in that material or in the Appropriate Legal Notices displayed
by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in reasonable
ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some trade
names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that material
by anyone who conveys the material (or modified versions of it) with
contractual assumptions of liability to the recipient, for any liability
that these contractual assumptions directly impose on those
licensors and authors.
All other non-permissive additional terms are considered “further restrictions”
within the meaning of section 10. If the Program as you received it, or any
part of it, contains a notice stating that it is governed by this License
along with a term that is a further restriction, you may remove that term.
If a license document contains a further restriction but permits relicensing
or conveying under this License, you may add to a covered work material
governed by the terms of that license document, provided that the further
restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place,
in the relevant source files, a statement of the additional terms that apply
to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of
a separately written license, or stated as exceptions; the above
requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly provided
under this License. Any attempt otherwise to propagate or modify it is void,
and will automatically terminate your rights under this License (including
any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a
particular copyright holder is reinstated (a) provisionally, unless and until
the copyright holder explicitly and finally terminates your license, and
(b) permanently, if the copyright holder fails to notify you of the violation
by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated
permanently if the copyright holder notifies you of the violation by some
reasonable means, this is the first time you have received notice of violation
of this License (for any work) from that copyright holder, and you cure the
violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses
of parties who have received copies or rights from you under this License.
If your rights have been terminated and not permanently reinstated, you do
not qualify to receive new licenses for the same material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or run a copy
of the Program. Ancillary propagation of a covered work occurring solely as
a consequence of using peer-to-peer transmission to receive a copy likewise
does not require acceptance. However, nothing other than this License grants
you permission to propagate or modify any covered work. These actions infringe
copyright if you do not accept this License. Therefore, by modifying or
propagating a covered work, you indicate your acceptance
of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically receives a
license from the original licensors, to run, modify and propagate that work,
subject to this License. You are not responsible for enforcing compliance
by third parties with this License.
An “entity transaction” is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered work
results from an entity transaction, each party to that transaction who receives
a copy of the work also receives whatever licenses to the work the party's
predecessor in interest had or could give under the previous paragraph, plus a
right to possession of the Corresponding Source of the work from the
predecessor in interest, if the predecessor has it or can get it
with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights
granted or affirmed under this License. For example, you may not impose a
license fee, royalty, or other charge for exercise of rights granted under
this License, and you may not initiate litigation (including a cross-claim
or counterclaim in a lawsuit) alleging that any patent claim is infringed
by making, using, selling, offering for sale, or importing the Program
or any portion of it.
11. Patents.
A “contributor” is a copyright holder who authorizes use under this License
of the Program or a work on which the Program is based. The work thus licensed
is called the contributor's “contributor version”.
A contributor's “essential patent claims” are all patent claims owned or
controlled by the contributor, whether already acquired or hereafter acquired,
that would be infringed by some manner, permitted by this License, of making,
using, or selling its contributor version, but do not include claims that
would be infringed only as a consequence of further modification of the
contributor version. For purposes of this definition, “control” includes
the right to grant patent sublicenses in a manner consistent with the
requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent
license under the contributor's essential patent claims, to make, use, sell,
offer for sale, import and otherwise run, modify and propagate the contents
of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement
or commitment, however denominated, not to enforce a patent (such as an
express permission to practice a patent or covenant not to sue for patent
infringement). To “grant” such a patent license to a party means to make such
an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the
Corresponding Source of the work is not available for anyone to copy, free of
charge and under the terms of this License, through a publicly available
network server or other readily accessible means, then you must either
(1) cause the Corresponding Source to be so available, or (2) arrange to
deprive yourself of the benefit of the patent license for this particular work,
or (3) arrange, in a manner consistent with the requirements of this License,
to extend the patent license to downstream recipients. “Knowingly relying”
means you have actual knowledge that, but for the patent license, your
conveying the covered work in a country, or your recipient's use of the
covered work in a country, would infringe one or more identifiable patents
in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement,
you convey, or propagate by procuring conveyance of, a covered work, and
grant a patent license to some of the parties receiving the covered work
authorizing them to use, propagate, modify or convey a specific copy of the
covered work, then the patent license you grant is automatically extended
to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope
of its coverage, prohibits the exercise of, or is conditioned on the
non-exercise of one or more of the rights that are specifically granted under
this License. You may not convey a covered work if you are a party to an
arrangement with a third party that is in the business of distributing
software, under which you make payment to the third party based on the extent
of your activity of conveying the work, and under which the third party grants,
to any of the parties who would receive the covered work from you, a
discriminatory patent license (a) in connection with copies of the covered
work conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that contain
the covered work, unless you entered into that arrangement, or that patent
license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any
implied license or other defenses to infringement that may otherwise be
available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not excuse
you from the conditions of this License. If you cannot convey a covered work
so as to satisfy simultaneously your obligations under this License and any
other pertinent obligations, then as a consequence you may not convey it
at all. For example, if you agree to terms that obligate you to collect a
royalty for further conveying from those to whom you convey the Program,
the only way you could satisfy both those terms and this License would be
to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have permission to
link or combine any covered work with a work licensed under version 3 of the
GNU Affero General Public License into a single combined work, and to convey
the resulting work. The terms of this License will continue to apply to the
part which is the covered work, but the special requirements of the
GNU Affero General Public License, section 13, concerning interaction through
a network will apply to the combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of the
GNU General Public License from time to time. Such new versions will be similar
in spirit to the present version, but may differ in detail to address
new problems or concerns.
Each version is given a distinguishing version number. If the Program
specifies that a certain numbered version of the GNU General Public License
“or any later version” applies to it, you have the option of following the
terms and conditions either of that numbered version or of any later version
published by the Free Software Foundation. If the Program does not specify a
version number of the GNU General Public License, you may choose any version
ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the
GNU General Public License can be used, that proxy's public statement of
acceptance of a version permanently authorizes you to choose that
version for the Program.
Later license versions may give you additional or different permissions.
However, no additional obligations are imposed on any author or copyright
holder as a result of your choosing to follow a later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE
LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER
PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO
THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM
PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL
ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE
PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE
OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA
OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES
OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided above
cannot be given local legal effect according to their terms, reviewing courts
shall apply local law that most closely approximates an absolute waiver of
all civil liability in connection with the Program, unless a warranty or
assumption of liability accompanies a copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest possible
use to the public, the best way to achieve this is to make it free software
which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach
them to the start of each source file to most effectively state the exclusion
of warranty; and each file should have at least the “copyright” line and a
pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) 2020 Timo Hocker
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like
this when it starts in an interactive mode:
bin Copyright (C) 2020 Timo Hocker
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school,
if any, to sign a “copyright disclaimer” for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL,
see <http://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Lesser General Public
License instead of this License.
But first, please read <http://www.gnu.org/philosophy/why-not-lgpl.html>.
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

View File

@ -1,34 +1,57 @@
# Snippeteer
# @sapphirecode/snippeteer
version: 1.3.x
macros for setting up projects or project parts
## Installation
to work with the @scode scope you have to add the following line to your npmrc.
for this particular one you'll have to add it to the global npmrc stored in your home folder (~/.npmrc)
> npm i -g @sapphirecode/snippeteer
```npmrc
@scode:registry=https://npm.scode.ovh
```
## Requirements
then install the module using the following command
installed on the system:
```sh
npm i -g @scode/snippeteer
```
- yarn
- git
## Usage
```sh
snippeteer [snippet] [..args]
```
run `snippeteer` in console and choose a snippet, all necessary parameters will
be asked interactively
All snippets will be executed relative to your current working directory!
### Snippets
## Snippets
#### copyright
### Snippet
add copyright notice to .js, .ts and .mjs files, as well was generating a
license file and adding fields like author and license to the package.json
Creates a new snippet template
#### jenkins
```sh
snippeteer snippet [name]
```
create a generic jenkinsfile
for node projects: automatically generates a jenkinsfile and jenkins.js for easy
use in jenkins.
necessary scripts in the package.json:
- ci: `yarn --frozen-lockfile && node jenkins.js`
- compile: `tsc` or
`tsc --allowJs --declaration --emitDeclarationOnly index.js`, ...
compile should be the general compile task, for typescript: tsc, for commonjs:
creating type definitions, ...
#### node
initializes a node project with the standard structure used by sapphirecode
modules
#### readme
create a template readme file
## License
BSD-3-Clause © Timo Hocker <timo@scode.ovh>

View File

@ -1,43 +1,14 @@
#!/usr/bin/env node
/* eslint-disable no-console */
/* eslint-disable global-require */
/* eslint-disable no-sync */
const { argv } = require ('yargs');
const path = require ('path');
const fs = require ('fs-extra');
const [
template,
...args
] = argv._;
/**
* main function
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
function main () {
if (typeof template !== 'string') {
console.log ('please specify a template');
return;
}
if (
!fs.existsSync (path.join (__dirname, 'snippets', template))
|| !(/^[a-zA-Z]+$/u).test (template)
) {
console.log ('template does not exist');
return;
}
'use strict';
const snippet = require (`./snippets/${template}/index.js`);
const folder = process.cwd ();
if (!snippet.assert (folder, args)) {
console.log ('snipped rejected arguments');
return;
}
snippet.run (folder, args);
}
main ();
// @ts-ignore
// eslint-disable-next-line node/no-missing-require
require ('./dist');

View File

@ -1,7 +1,29 @@
const fs = require ('fs');
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, June 2020
*/
const pkg = JSON.parse (fs.readFileSync ('package.json', 'utf-8'));
[
,, pkg.version
'use strict';
const https = require ('https');
const fs = require ('fs');
const { execSync: exec_sync } = require ('child_process');
const run_file = fs.createWriteStream ('.jenkins.run.js');
const [
,, ...args
] = process.argv;
fs.writeFileSync ('package.json', JSON.stringify (pkg, null, 2));
run_file.on ('close', () => {
exec_sync (`node .jenkins.run.js ${args.join (' ')}`, { stdio: 'inherit' });
});
https.get (
'https://git.scode.ovh/Timo/standard/raw/branch/master/jenkins.run.js',
(msg) => {
msg.pipe (run_file);
}
);

24
lib/.eslintrc.js Normal file
View File

@ -0,0 +1,24 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
/* eslint-disable */
'use strict';
module.exports = {
env: {
commonjs: true,
es6: true,
node: true
},
extends: [ '@sapphirecode/eslint-config-ts' ],
globals: {
Atomics: 'readonly',
SharedArrayBuffer: 'readonly'
},
parserOptions: { ecmaVersion: 2018 }
};

66
lib/Helper.ts Normal file
View File

@ -0,0 +1,66 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
import path from 'path';
import child_process from 'child_process';
import fs from 'fs-extra';
/**
* write a template to a file
*
* @param contents - file contents
* @param destination - file destination
*/
async function apply_template (
contents: string,
destination: string
): Promise<void> {
const dst = path.join (process.cwd (), destination);
if (!await fs.pathExists (dst)) {
await fs.mkdirp (path.dirname (dst));
await fs.writeFile (dst, contents);
}
}
type JSONMutator = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
(json: any): any;
}
/**
* modify a json file
*
* @param func - function that modifies the object
* @param json_path - path of json file
*/
async function modify_json (
func: JSONMutator,
json_path = 'package.json'
): Promise<void> {
const file_path = path.join (process.cwd (), json_path);
const content = JSON.parse (await fs.readFile (file_path, 'utf-8'));
const new_obj = await func (content);
if (typeof new_obj === 'undefined' || new_obj === null)
return;
await fs.writeFile (file_path, JSON.stringify (new_obj, null, 2));
}
/**
* run a command
*
* @param command - command to run
* @param folder - folder to run in
*/
function run_command (command: string, folder = ''): void {
// eslint-disable-next-line no-sync
child_process.execSync (
command,
{ cwd: path.join (process.cwd (), folder), stdio: 'inherit' }
);
}
export { modify_json, apply_template, run_command };

11
lib/Snippet.ts Normal file
View File

@ -0,0 +1,11 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
export interface Snippet {
is_active(): boolean;
start(cwd: string): Promise<void>;
}

13
lib/dialog.ts Normal file
View File

@ -0,0 +1,13 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
export class DialogHandler {
public static catch (): void {
// eslint-disable-next-line no-process-exit
process.exit ();
}
}

8
lib/enquirer.d.ts vendored Normal file
View File

@ -0,0 +1,8 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
declare module 'enquirer';

33
lib/index.ts Normal file
View File

@ -0,0 +1,33 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
import path from 'path';
import fs from 'fs-extra';
import { AutoComplete } from 'enquirer';
import { Snippet } from './Snippet';
(async (): Promise<void> => {
const snippets = await fs.readdir (path.join (__dirname, 'snippets'));
const runners: Record<string, Snippet> = {};
await Promise.all (
snippets.map (async (s) => {
const runner = (new (
await import (`./snippets/${s}/index.js`)
).default) as Snippet;
runners[s] = runner;
})
);
const snippet = await new AutoComplete ({
name: 'snippet',
message: 'choose a snippet',
choices: snippets.filter ((s) => runners[s].is_active ())
})
.run ();
runners[snippet].start (process.cwd ());
}) ()
// eslint-disable-next-line no-console
.catch ((e) => console.log (e));

View File

@ -0,0 +1,46 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
import { CopyrightOptions } from './copyright_options';
export class CopyrightGenerator {
public static get_copyright_notice (
opt: CopyrightOptions,
date_str?: string
): string {
let notice = '';
let date_string = date_str;
if (typeof date_str === 'undefined') {
const date = (new Date);
const dtf = new Intl.DateTimeFormat ('en', { month: 'long' });
const year = date.getFullYear ();
const month = dtf.format (date);
date_string = `${month} ${year}`;
}
if (opt.has_license) {
notice = `${'/*'}
* Copyright (C) ${opt.company || opt.author} - All Rights Reserved
* This file is part of ${opt.software} which is released under ${
opt.license}.
* See file 'LICENSE' for full license details.
* Created by ${opt.author} <${opt.email}>, ${date_string}
*/
`;
}
else {
notice = `${'/*'}
* Copyright (C) ${opt.company || opt.author} - All Rights Reserved
* Created by ${opt.author} <${opt.email}>, ${date_string}
*/
`;
}
return notice;
}
}

View File

@ -0,0 +1,15 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
export class CopyrightOptions {
public has_license = false;
public license = '';
public author = '';
public company = '';
public email = '';
public software = '';
}

View File

@ -0,0 +1,34 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
/* eslint-disable no-await-in-loop */
import path from 'path';
import fs from 'fs-extra';
export class FileMapper {
public static async map_all_files (
folder: string,
mutator: (data: string, file: string, args: Array<unknown>) => string|null,
args: Array<unknown> = []
): Promise<void> {
const files = await fs.readdir (folder);
for (const file of files) {
if ([ 'node_modules' ].includes (file))
continue;
const abs_path = path.join (folder, file);
if ((await fs.stat (abs_path)).isDirectory ()) {
await FileMapper.map_all_files (abs_path, mutator, args);
continue;
}
const data = await fs.readFile (abs_path, 'utf-8');
const res = mutator (data, file, args);
if (res === null)
continue;
await fs.writeFile (abs_path, res, 'utf-8');
}
}
}

View File

@ -0,0 +1,155 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
/* eslint-disable no-await-in-loop */
import path from 'path';
import fs from 'fs-extra';
import { Confirm, Input, AutoComplete } from 'enquirer';
// eslint-disable-next-line id-match
import { findLicense, getLicense } from 'license';
import { Snippet } from '../../Snippet';
import { DialogHandler } from '../../dialog';
import { modify_json } from '../../Helper';
import { CopyrightGenerator } from './copyright_generator';
import { FileMapper } from './file_mapper';
import { CopyrightOptions } from './copyright_options';
export default class Copyright implements Snippet {
public is_active (): boolean {
return true;
}
private _options: CopyrightOptions | null = null;
private _cwd = '';
private _loaded_from_config = false;
async start (cwd: string): Promise<void> {
this._cwd = cwd;
await this.load_options_file ();
if (!this._options)
await this.gather_options ();
const options = this._options as CopyrightOptions;
await FileMapper.map_all_files (
this._cwd,
this.fix_file_license.bind (this)
);
await modify_json ((json) => {
json.author = `${options.author} <${options.email}>`;
json.license = options.has_license ? options.license : 'UNLICENSED';
return json;
});
if (options.has_license) {
await fs.writeFile (
path.join (cwd, 'LICENSE'),
getLicense (options.license, {
name: options.author,
email: options.email,
project: options.software
})
);
}
if (
!this._loaded_from_config
&& (await new Confirm (
{ message: 'should those settings be saved for the next run?' }
)
.run ()
.catch (DialogHandler.catch))
)
this.save_options_file ();
}
private async gather_options (): Promise<void> {
this._options = (new CopyrightOptions);
this._options.author = await new Input ({ message: 'author' })
.run ()
.catch (DialogHandler.catch);
this._options.email = await new Input ({ message: 'email' })
.run ()
.catch (DialogHandler.catch);
this._options.company = await new Input ({ message: 'company' })
.run ()
.catch (DialogHandler.catch);
this._options.software = await new Input ({ message: 'software name' })
.run ()
.catch (DialogHandler.catch);
this._options.has_license = await new Confirm (
{ message: 'would you like to specify a license?' }
)
.run ()
.catch (DialogHandler.catch);
if (this._options.has_license) {
this._options.license = await new AutoComplete ({
name: 'license',
message: 'choose a license',
limit: 10,
choices: findLicense ('')
})
.run ()
.catch (DialogHandler.catch);
}
}
private async load_options_file (): Promise<void> {
const file_path = path.join (this._cwd, '.liconfig.json');
this._options = null;
if (await fs.pathExists (file_path)) {
const options = JSON.parse (await fs.readFile (file_path, 'utf-8'));
// eslint-disable-next-line no-console
console.log (`author: ${options.author}
email: ${options.email}
company: ${options.company}
software name: ${options.software}
license: ${options.license}`);
const should_load = await new Confirm (
{ message: 'should those options be used?' }
)
.run ()
.catch (DialogHandler.catch);
if (should_load) {
this._options = options;
this._loaded_from_config = true;
}
}
}
private async save_options_file (): Promise<void> {
const file_path = path.join (this._cwd, '.liconfig.json');
await fs.writeFile (
file_path,
JSON.stringify (this._options, null, 2),
'utf-8'
);
}
private fix_file_license (data: string, filename: string): string | null {
// eslint-disable-next-line max-len
const regex = /\/\*\s+\*\sCopyright[\s\S]*?(?:Created by.*?, (?<date>[a-z]+ [0-9]+)[\s\S]*?|\s)\*\/\n{0,2}/gui;
const shebang = /^#!.*?\n\n/gu;
const shebang_line = shebang.exec (data);
if (!(/\.(?:js|ts|mjs)$/u).test (filename) && !regex.test (data))
return null;
const res = regex.exec (data);
return (
(shebang_line ? shebang_line[0] : '')
+ CopyrightGenerator.get_copyright_notice (
this._options as CopyrightOptions,
res?.groups?.date
)
+ data.replace (regex, '')
.replace (shebang, '')
);
}
}

View File

@ -0,0 +1,56 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
/* eslint-disable max-len */
import { files } from '@sapphirecode/standard';
const general = { jenkinsfile: '' };
const node = { jenkinsfile: files.jenkinsfile, js: files.jenkins };
general.jenkinsfile = `pipeline {
agent any
environment {
VERSION = VersionNumber([
versionNumberString:
'\${BUILDS_ALL_TIME}',
versionPrefix: '1.0.',
worstResultForIncrement: 'SUCCESS'
])
publish = 0
}
stages {
stage('Setup') {
steps {
script {
currentBuild.displayName = env.VERSION
}
echo 'Setting up test environment'
sh 'echo setup'
}
}
}
post {
success {
script {
publish = sh script: "git log -1 | grep '\\\\[no publish\\\\]'", returnStatus: true
if (publish != 0) {
echo 'Deploying'
sh 'echo deploy'
} else {
echo 'Build successful, Commit not marked for deploying'
currentBuild.result = "UNSTABLE"
}
}
}
}
}
`;
export { general, node };

View File

@ -0,0 +1,39 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
import { Confirm } from 'enquirer';
import { Snippet } from '../../Snippet';
import { apply_template, modify_json } from '../../Helper';
import { general, node } from './Assets';
export default class Jenkins implements Snippet {
public is_active (): boolean {
return true;
}
public async start (): Promise<void> {
const is_node = await new Confirm ({
message: 'is the current project using nodejs?',
initial: true
})
.run ();
if (is_node) {
await apply_template (node.js, 'jenkins.js');
await apply_template (node.jenkinsfile, 'Jenkinsfile');
// eslint-disable-next-line @typescript-eslint/no-explicit-any
await modify_json ((obj: any): any => {
obj.scripts.ci = 'yarn && node jenkins.js';
return obj;
});
}
else {
await apply_template (general.jenkinsfile, 'Jenkinsfile');
}
}
}

View File

@ -0,0 +1,70 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
const eslintrc = `module.exports = {
env: {
commonjs: true,
es6: true,
node: true
},
extends: [
'@sapphirecode'
],
globals: {
Atomics: 'readonly',
SharedArrayBuffer: 'readonly'
},
parserOptions: {
ecmaVersion: 2018
}
}
`;
const eslintrc_ts = `module.exports = {
env: {
commonjs: true,
es6: true,
node: true
},
extends: [
'@sapphirecode/eslint-config-ts'
],
globals: {
Atomics: 'readonly',
SharedArrayBuffer: 'readonly'
},
parserOptions: {
ecmaVersion: 2018
}
}
`;
const gitignore = `/node_modules/
/dist/
/.nyc_output/
/coverage/
`;
const tsconfig = `{
"compilerOptions": {
"target": "es5",
"module": "commonjs",
"outDir": "./dist",
"rootDir": "./lib",
"strict": true,
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"declaration": true
}
}
`;
const eslintignore = `/dist/
*.d.ts
`;
export { eslintrc, gitignore, tsconfig, eslintrc_ts, eslintignore };

105
lib/snippets/node/index.ts Normal file
View File

@ -0,0 +1,105 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, May 2020
*/
import path from 'path';
import { Input, Confirm } from 'enquirer';
import { scripts as standard_scripts } from '@sapphirecode/standard';
import { Snippet } from '../../Snippet';
import { apply_template, modify_json, run_command } from '../../Helper';
import {
eslintrc, gitignore,
tsconfig, eslintrc_ts, eslintignore
} from './Assets';
/**
* initialize the package.json
*
* @param folder - folder
* @param use_ts - use typescript
* @param use_tests - use tests
*/
async function init_package (
folder: string,
use_ts: boolean,
use_tests: boolean
): Promise<void> {
await modify_json ((obj: Record<string, unknown>) => {
const scripts
= {
lint: standard_scripts.lint,
test: standard_scripts.test.common,
compile: standard_scripts.compile.common
};
const files = [ 'LICENSE' ];
if (use_ts) {
scripts.compile = standard_scripts.compile.ts;
scripts.test = standard_scripts.test.ts;
files.push ('/dist/');
}
else {
files.push ('*.js', '*.d.ts');
}
if (!use_tests)
scripts.test = standard_scripts.test.no;
obj.scripts = scripts;
obj.files = files;
return obj;
}, path.join (folder, 'package.json'));
}
export default class Node implements Snippet {
public is_active (): boolean {
return true;
}
public async start (): Promise<void> {
const folder = await new Input (
{ message: 'project name (leave empty for current folder):' }
)
.run ();
const use_ts = await new Confirm ({
message: 'use typescript?',
initial: false
})
.run ();
const use_tests = await new Confirm ({
message: 'use tests?',
initial: true
})
.run ();
await apply_template (eslintrc, path.join (folder, '.eslintrc.js'));
await apply_template (gitignore, path.join (folder, '.gitignore'));
await apply_template (
eslintignore,
path.join (folder, '.eslintignore')
);
if (use_ts) {
await apply_template (tsconfig, path.join (folder, 'tsconfig.json'));
await apply_template (
eslintrc_ts,
path.join (folder, 'lib', '.eslintrc.js')
);
}
run_command ('git init', folder);
run_command ('yarn init -y', folder);
run_command (
`yarn add --dev @sapphirecode/eslint-config${use_ts
? '-ts typescript @ava/typescript'
: ''} eslint nyc ava`,
folder
);
await init_package (folder, use_ts, use_tests);
}
}

View File

@ -0,0 +1,40 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, June 2020
*/
/* eslint-disable max-len */
export function get_readme (
software: string,
description: string,
dev: boolean,
license: string,
author: string
): string {
return `# ${software}
version: 0.0.0
${description}
## Installation
npm:
> npm i --save${dev ? '-dev' : ''} ${software}
yarn:
> yarn add ${dev ? '--dev ' : ''}${software}
## Usage
TODO: Add usage
## License
${license} © ${author}
`;
}

View File

@ -0,0 +1,45 @@
/*
* Copyright (C) SapphireCode - All Rights Reserved
* This file is part of Snippeteer which is released under BSD-3-Clause.
* See file 'LICENSE' for full license details.
* Created by Timo Hocker <timo@scode.ovh>, June 2020
*/
import { Confirm } from 'enquirer';
import { Snippet } from '../../Snippet';
import { modify_json, apply_template } from '../../Helper';
import { get_readme } from './Assets';
export default class Readme implements Snippet {
public is_active (): boolean {
return true;
}
public async start (): Promise<void> {
const dev = await new Confirm ({
message: 'is the package used as dev dependency?',
default: false
})
.run ();
const package_data = {
software: '',
description: '',
license: '',
author: ''
};
await modify_json ((json) => {
package_data.software = json.name;
package_data.description = json.description;
package_data.license = json.license;
package_data.author = json.author;
});
const readme = get_readme (
package_data.software,
package_data.description,
dev,
package_data.license,
package_data.author
);
await apply_template (readme, 'README.md');
}
}

1793
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,5 +1,5 @@
{
"name": "@scode/snippeteer",
"name": "@sapphirecode/snippeteer",
"version": "1.0.0",
"description": "macros for setting up projects or project parts",
"main": "index.js",
@ -7,20 +7,38 @@
"snippeteer": "./index.js"
},
"scripts": {
"lint": "eslint --fix ."
"lint": "eslint . --ext .js,.jsx,.ts,.tsx,.vue,.mjs",
"ci": "yarn --frozen-lockfile && node jenkins.js",
"test": "echo \"no test\"",
"compile": "tsc"
},
"repository": {
"type": "git",
"url": "git@git.scode.ovh:timo/snippeteer"
},
"author": "Timo Hocker",
"license": "GPL-3.0-or-later",
"files": [
"/dist/",
"/lib/",
"LICENSE"
],
"author": "Timo Hocker <timo@scode.ovh>",
"license": "BSD-3-Clause",
"devDependencies": {
"@scode/eslint-config": "^1.1.10",
"eslint": "^6.8.0"
"@sapphirecode/eslint-config-ts": "^1.0.22",
"@types/fs-extra": "^9.0.0",
"@types/node": "^14.0.1",
"eslint": "^7.0.0",
"typescript": "^3.8.3"
},
"dependencies": {
"fs-extra": "^8.1.0",
"yargs": "^15.1.0"
"@sapphirecode/console-app": "^2.0.6",
"@sapphirecode/modelling": "^1.1.6",
"@sapphirecode/standard": "^1.0.1",
"enquirer": "^2.3.5",
"fs-extra": "^9.0.0",
"license": "^1.0.3"
},
"engines": {
"node": ">=10.0.0"
}
}
}

View File

@ -1,68 +0,0 @@
/* eslint-disable no-sync */
/* eslint-disable no-console */
const fs = require ('fs-extra');
const path = require ('path');
/**
* copies the full template to a new folder named after arg[0]
*
* @param {string} folder folder to run in
* @param {Array} args function arguments
*/
function run (folder, args) {
const snip_folder = path.join (folder, args[0]);
const template = path.join (__dirname, 'template');
fs.mkdir (snip_folder);
fs.copy (template, snip_folder);
}
/**
* checks if the arguments meet the requirements
*
* @param {string} folder folder to run in
* @param {Array} args function arguments
* @returns {boolean} true if arguments match requirements
*/
function assert (folder, args) {
const tests = [
{
f: () => (args.length < 2),
reason: 'too many arguments'
},
{
f: () => (args.length === 0 || typeof args[0] === 'string'),
reason: 'name is not a string'
},
{
f: () => (args.length === 0 || (/^[a-z]+$/iu).test (args[0])),
reason: 'name can only contain [a-z]'
},
{
f: () => (typeof folder === 'string'),
reason: 'cwd is not a folder (internal error)'
},
{
f: () => (fs.existsSync (folder)),
reason: 'cwd does not exist (internal error)'
},
{
f: () => (args.length === 1 || fs.readdirSync (folder).length === 0),
reason: 'folder is not empty'
},
{
f: () => (args.length === 0
|| !fs.existsSync (path.join (folder, args[0]))),
reason: 'folder already exists'
}
];
for (const test of tests)
if (!test.f ()) {
console.log (test.reason);
return false;
}
return true;
}
module.exports = { run, assert };

View File

@ -1,68 +0,0 @@
/* eslint-disable no-sync */
/* eslint-disable no-console */
const fs = require ('fs-extra');
const path = require ('path');
/**
* copies the full template to a new folder named after arg[0]
*
* @param {string} folder folder to run in
* @param {Array} args function arguments
*/
function run (folder, args) {
const snip_folder = path.join (folder, args[0]);
const template = path.join (__dirname, 'template');
fs.mkdir (snip_folder);
fs.copy (template, snip_folder);
}
/**
* checks if the arguments meet the requirements
*
* @param {string} folder folder to run in
* @param {Array} args function arguments
* @returns {boolean} true if arguments match requirements
*/
function assert (folder, args) {
const tests = [
{
f: () => (args.length < 2),
reason: 'too many arguments'
},
{
f: () => (args.length === 0 || typeof args[0] === 'string'),
reason: 'name is not a string'
},
{
f: () => (args.length === 0 || (/^[a-z]+$/iu).test (args[0])),
reason: 'name can only contain [a-z]'
},
{
f: () => (typeof folder === 'string'),
reason: 'cwd is not a folder (internal error)'
},
{
f: () => (fs.existsSync (folder)),
reason: 'cwd does not exist (internal error)'
},
{
f: () => (args.length === 1 || fs.readdirSync (folder).length === 0),
reason: 'folder is not empty'
},
{
f: () => (args.length === 0
|| !fs.existsSync (path.join (folder, args[0]))),
reason: 'folder already exists'
}
];
for (const test of tests)
if (!test.f ()) {
console.log (test.reason);
return false;
}
return true;
}
module.exports = { run, assert };

66
tsconfig.json Normal file
View File

@ -0,0 +1,66 @@
{
"compilerOptions": {
/* Basic Options */
// "incremental": true, /* Enable incremental compilation */
"target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
"module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
// "lib": [], /* Specify library files to be included in the compilation. */
// "allowJs": true, /* Allow javascript files to be compiled. */
// "checkJs": true, /* Report errors in .js files. */
// "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
"declaration": true, /* Generates corresponding '.d.ts' file. */
"declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
"sourceMap": true, /* Generates corresponding '.map' file. */
// "outFile": "./", /* Concatenate and emit output to single file. */
"outDir": "./dist", /* Redirect output structure to the directory. */
"rootDir": "./lib", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
// "composite": true, /* Enable project compilation */
// "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
// "removeComments": true, /* Do not emit comments to output. */
// "noEmit": true, /* Do not emit outputs. */
// "importHelpers": true, /* Import emit helpers from 'tslib'. */
// "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
// "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
/* Strict Type-Checking Options */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* Enable strict null checks. */
// "strictFunctionTypes": true, /* Enable strict checking of function types. */
// "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
// "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
// "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
// "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
/* Additional Checks */
// "noUnusedLocals": true, /* Report errors on unused locals. */
// "noUnusedParameters": true, /* Report errors on unused parameters. */
// "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
// "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
/* Module Resolution Options */
// "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
// "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
// "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
// "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
// "typeRoots": [], /* List of folders to include type definitions from. */
// "types": [], /* Type declaration files to be included in compilation. */
// "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
"esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
// "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
/* Source Map Options */
// "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
// "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
/* Experimental Options */
// "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
// "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
/* Advanced Options */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
}
}

1670
yarn.lock Normal file

File diff suppressed because it is too large Load Diff