Skip to content

Commit

Permalink
init project.
Browse files Browse the repository at this point in the history
  • Loading branch information
jaywcjlove committed Mar 7, 2022
1 parent cadec6e commit c3986a4
Show file tree
Hide file tree
Showing 39 changed files with 1,363 additions and 2 deletions.
17 changes: 17 additions & 0 deletions .gitignore
@@ -0,0 +1,17 @@
lib
dist
build
node_modules
npm-debug.log*
package-lock.json
.eslintcache
.DS_Store
.cache
.vscode

*.bak
*.tem
*.temp
#.swp
*.*~
~*.*
4 changes: 4 additions & 0 deletions .husky/pre-commit
@@ -0,0 +1,4 @@
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx --no-install lint-staged
10 changes: 10 additions & 0 deletions .prettierignore
@@ -0,0 +1,10 @@
**/*.md
**/*.svg
**/*.ejs
**/*.yml
package.json
node_modules
dist
build
lib
test
11 changes: 11 additions & 0 deletions .prettierrc
@@ -0,0 +1,11 @@
{
"singleQuote": true,
"trailingComma": "all",
"printWidth": 120,
"overrides": [
{
"files": ".prettierrc",
"options": { "parser": "json" }
}
]
}
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 KKT

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 0 additions & 2 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
159 changes: 159 additions & 0 deletions core/README.md
@@ -0,0 +1,159 @@
@kkt/ncc
===

[![npm version](https://img.shields.io/npm/v/@kkt/ncc.svg)](https://www.npmjs.com/package/@kkt/ncc)

Simple CLI for compiling a Node.js module into a single file, together with all its dependencies, gcc-style. A tool created based on [`kkt`](https://github.com/kktjs/kkt) & [`create-react-app`](https://github.com/facebook/create-react-app), [`@kkt/ncc`](https://www.npmjs.com/package/@kkt/ncc) similar to [@vercel/ncc](https://www.npmjs.com/package/@vercel/ncc)

## Usage

## Quick Start

```bash
$ npx create-kkt my-app -e bundle-node
cd my-app
npm install
```

### Installation

```bash
npm i -g @kkt/ncc
```

### Usage

```bash
$ ncc <cmd> [input-file] [opts]
# input-file default value: src/index.ts
```

### Eg:

```bash
$ ncc build input.js -o dist
```

Outputs the `Node.js` compact build of `input.js` into `dist/input.js`.

## Commands

```bash
Usage: ncc [build|watch] [input-file] [--help|h]

Displays help information.

Options:

--version, -v Show version number
--help, -h Displays help information.
-o, --out [dir] Output directory for build (defaults to dist).
-m, --minify Minify output.
-t, --target Instructs webpack to target a specific environment (defaults to node14).
-l, --library Output a library exposing the exports of your entry point. The parameter "--target=web" works.
-s, --source-map Generate source map.
-e, --external [mod] Skip bundling 'mod'. Can be used many times.
--filename output file name.

Example:

$ ncc build
$ ncc build --out ./dist
$ ncc build --minify
$ ncc watch --minify
$ ncc build src/app.ts
$ ncc build --target web --library MyLibrary
$ ncc build --source-map
```

## Configuration File

Supports `.kktrc.js` and `.kktrc.ts`. Configuration [Example](https://github.com/uiwjs/react-codemirror/blob/880754a18ace17f40571330985d85e7eca770351/.kktrc.ts#L11-L74):

```typescript
import webpack, { Configuration } from 'webpack';
import { LoaderConfOptions } from 'kkt';
import lessModules from '@kkt/less-modules';

export default (conf: Configuration, env: 'development' | 'production', options: LoaderConfOptions) => {
conf = lessModules(conf, env, options);
if (options.bundle) {
conf.output!.library = '@uiw/codemirror';
conf.output!.filename = `codemirror${options.minify ? '.min.js' : '.js'}`;
conf.externals = {
'@codemirror/basic-setup': {
root: ['CM', '@codemirror/basic-setup'],
commonjs: '@codemirror/basic-setup',
commonjs2: '@codemirror/basic-setup',
},
oneDark: {
root: ['CM', '@codemirror/theme-one-dark', 'oneDark'],
},
StateEffect: {
root: ['CM', '@codemirror/state', 'StateEffect'],
},
EditorState: {
root: ['CM', '@codemirror/basic-setup', 'EditorState'],
},
react: {
root: 'React',
commonjs2: 'react',
commonjs: 'react',
amd: 'react',
},
'react-dom': {
root: 'ReactDOM',
commonjs2: 'react-dom',
commonjs: 'react-dom',
amd: 'react-dom',
},
};
} else {
// ......
}
return conf;
};

```

## Example

- [Github Action Contributors](https://github.com/jaywcjlove/github-action-contributors) Github action generates dynamic image URL for contributor list to display it!
- [Generated Badges](https://github.com/jaywcjlove/generated-badges) Create a badge using GitHub Actions (no 3rd parties servers).
- [Coverage Badges](https://github.com/jaywcjlove/coverage-badges-cli) Create coverage badges from coverage reports (no 3rd parties servers).
- [@uiw/react-codemirror](https://github.com/uiwjs/react-codemirror) CodeMirror 6 component for React.
- [@uiw/react-split](https://github.com/uiwjs/react-split) A piece of view can be divided into areas where the width or height can be adjusted by dragging.
- [@uiw/react-layout](https://github.com/uiwjs/react-layout) Layout component for React. Handling the overall layout of a page.
- [@uiw/react-amap](https://github.com/uiwjs/react-amap) 基于 React 封装的高德地图组件。
- [@uiw/react-baidu-map](https://github.com/uiwjs/react-baidu-map) 基于 React 封装的百度地图组件。
- [@uiw/react-markdown-preview](https://github.com/uiwjs/react-markdown-preview) React component preview markdown text in web browser.
- [@uiw/react-textarea-code-editor](https://github.com/uiwjs/react-textarea-code-editor) A simple code editor with syntax highlighting.
- [@uiw/react-heat-map](https://github.com/uiwjs/react-heat-map) A lightweight calendar heatmap react component.
- [uiw](https://github.com/uiwjs/uiw) A high quality UI Toolkit, A Component Library for React.
- [More...](https://github.com/kktjs/kkt/network/dependents?package_id=UGFja2FnZS0zMDE5ODU0NTI4)

### Development

Runs the project in development mode.

```bash
npm install
npm run hoist
npm run build

npm run watch
```

## Contributors

As always, thanks to our amazing contributors!

<a href="https://github.com/kktjs/ncc/graphs/contributors">
<img src="https://kktjs.github.io/ncc/CONTRIBUTORS.svg" />
</a>

Made with [github-action-contributors](https://github.com/jaywcjlove/github-action-contributors).

### License

Licensed under the MIT License
29 changes: 29 additions & 0 deletions core/package.json
@@ -0,0 +1,29 @@
{
"name": "@kkt/ncc",
"version": "1.0.9",
"description": "Simple CLI for compiling a Node.js module into a single file, together with all its dependencies, gcc-style.",
"author": "Kenny Wong <wowohoo@qq.com> (https://github.com/jaywcjlove)",
"repository": "https://github.com/kktjs/kkt/tree/master/packages/ncc",
"license": "MIT",
"bin": {
"ncc": "./lib/index.js"
},
"files": [
"lib",
"src"
],
"keywords": [
"kkt",
"ncc",
"nodejs",
"cra",
"build-tools",
"create-react-app",
"zero-configuration",
"framework"
],
"dependencies": {
"css-minimizer-webpack-plugin": "~3.4.1",
"kkt": "~7.1.5"
}
}

0 comments on commit c3986a4

Please sign in to comment.