28 |
32 |
33 | );
34 | }
35 | }
36 |
--------------------------------------------------------------------------------
/docs/website/sidebars.json:
--------------------------------------------------------------------------------
1 | {
2 | "docs": {
3 | "Get Started": [
4 | "introduction",
5 | "create",
6 | "scripts",
7 | "examples"
8 | ],
9 | "Configuration": [
10 | "configuration",
11 | "configuration-noderize",
12 | "configuration-prettier",
13 | "configuration-jest"
14 | ],
15 | "Features": [
16 | "features",
17 | "features-modern",
18 | "features-flow",
19 | "features-typescript",
20 | "features-formatting",
21 | "features-testing",
22 | "features-linting"
23 | ],
24 | "Guides": [
25 | "guides",
26 | "guides-migrate",
27 | "guides-publishing",
28 | "guides-heroku",
29 | "guides-firebase-functions",
30 | "guides-google-functions"
31 | ],
32 | "Tutorials": [
33 | "tutorials",
34 | "tutorials-express",
35 | "tutorials-cli"
36 | ]
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/examples/chat-socket-react/web/src/App.css:
--------------------------------------------------------------------------------
1 | html, body {
2 | margin: 25px 5px;
3 | font-family: "Helvetica Neue", Helvetica, Arial, sans-serif;
4 | height: 100vh;
5 | }
6 |
7 | #app {
8 | max-width: 700px;
9 | width: 100%;
10 | margin: 0 auto;
11 | }
12 |
13 | #messages {
14 | height: 500px;
15 | overflow-y: auto;
16 | }
17 |
18 | #sidebar {
19 | grid-area: sidebar;
20 | border-bottom: #2e2e2e solid 1px;
21 | }
22 |
23 | #content {
24 | grid-area: content;
25 | }
26 |
27 | #grid {
28 | display: grid;
29 | grid-gap: 20px;
30 | grid-template-areas: "sidebar" "content"
31 | }
32 |
33 | @media (min-width: 700px) {
34 | #grid {
35 | grid-template-columns: 3fr 1fr;
36 | grid-template-areas: "content sidebar"
37 | }
38 |
39 | #sidebar {
40 | border-bottom: none;
41 | }
42 | }
--------------------------------------------------------------------------------
/packages/scripts/src/index.js:
--------------------------------------------------------------------------------
1 | import build from "./scripts/build";
2 | import start from "./scripts/start";
3 | import test from "./scripts/test";
4 | import watch from "./scripts/watch";
5 | import format from "./scripts/format";
6 | import clean from "./scripts/clean";
7 | import lint from "./scripts/lint";
8 | import { appLogger as log } from "./utils/logger";
9 | import packageJson from "../package.json";
10 |
11 | const commands = {
12 | build,
13 | test,
14 | watch,
15 | format,
16 | start,
17 | clean,
18 | lint
19 | };
20 |
21 | const args = process.argv.slice(2);
22 |
23 | const script = args.shift();
24 |
25 | log.info(`Noderize version ${packageJson.version}`);
26 |
27 | if (!Object.keys(commands).includes(script)) {
28 | log.warn(`Unknown script.`);
29 | process.exit(1);
30 | } else {
31 | commands[script](args, process.argv);
32 | }
33 |
--------------------------------------------------------------------------------
/docs/website/static/img/download.svg:
--------------------------------------------------------------------------------
1 |
4 |
--------------------------------------------------------------------------------
/docs/docs/examples.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: examples
3 | title: Examples
4 | ---
5 |
6 | See [examples](https://github.com/Cretezy/Noderize/tree/master/examples) of using Noderize.
7 |
8 | ## Index
9 |
10 | * [Basic Express](https://github.com/Cretezy/Noderize/tree/master/examples/basic-express) ([tutorial](tutorials-express.md))
11 |
12 | Example of basic server using Express.
13 |
14 | * [Basic TypeScript](https://github.com/Cretezy/Noderize/tree/master/examples/basic-typescript)
15 |
16 | Example of basic TypeScript project.
17 |
18 | * [Basic Tests](https://github.com/Cretezy/Noderize/tree/master/examples/basic-tests)
19 |
20 | Example of basic tests in JavaScript and TypeScript.
21 |
22 | * [Chat Socket React](https://github.com/Cretezy/Noderize/tree/master/examples/chat-socket-react)
23 |
24 | Example of a more complete app using React and Socket.IO for an example chat server.
25 |
--------------------------------------------------------------------------------
/docs/website/static/css/custom.css:
--------------------------------------------------------------------------------
1 | .mainContainer .wrapper a,
2 | .inner .projectIntro a {
3 | text-decoration: underline;
4 | text-decoration-color: #abbdcd !important;
5 | }
6 |
7 | .mainContainer .wrapper a:hover,
8 | .mainContainer .wrapper a:focus,
9 | .inner .projectIntro a:hover,
10 | .inner .projectIntro a:focus {
11 | text-decoration: underline;
12 | text-decoration-color: #343a40 !important;
13 | }
14 |
15 | #feature .blockImage > img {
16 | height: 40px;
17 | }
18 |
19 | @media only screen and (min-device-width: 360px) and (max-device-width: 736px) {
20 | }
21 |
22 | @media only screen and (min-width: 736px) {
23 | #feature .blockImage > img {
24 | height: 50px;
25 | }
26 | }
27 |
28 | @media only screen and (max-width: 1023px) {
29 | }
30 |
31 | @media only screen and (min-width: 1400px) {
32 | }
33 |
34 | @media only screen and (min-width: 1500px) {
35 | }
36 |
--------------------------------------------------------------------------------
/examples/chat-socket-react/web/src/MessagesList.js:
--------------------------------------------------------------------------------
1 | import React from "react";
2 | import { List } from "./List";
3 |
4 | export class MessagesList extends React.PureComponent {
5 | list;
6 |
7 | render() {
8 | return (
9 |
10 |
31 | );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/packages/scripts/src/jestTransformer.js:
--------------------------------------------------------------------------------
1 | import { createTransformer } from "babel-jest";
2 |
3 | import createBabelConfig from "./createBabelConfig";
4 | import typescript from "typescript";
5 | import tsConfig from "./tsconfig.json";
6 | import { getOptions } from "./options";
7 |
8 | const options = getOptions(null, "test");
9 |
10 | export function process(src, path, ...rest) {
11 | const isTypeScript = path.endsWith(".ts");
12 | const isJavaScript = path.endsWith(".js");
13 |
14 | if (isTypeScript && options.languages.typescript) {
15 | src = typescript.transpile(src, tsConfig.compilerOptions, path, []);
16 | }
17 |
18 | if (isJavaScript || isTypeScript) {
19 | // Must use a temporary file name if TypeScript.
20 | const fileName = isJavaScript ? path : "file.js";
21 |
22 | src = createTransformer({
23 | ...createBabelConfig(options)
24 | }).process(src, fileName, ...rest);
25 | }
26 |
27 | return src;
28 | }
29 |
--------------------------------------------------------------------------------
/docs/docs/features-typescript.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: features-typescript
3 | title: Feature: TypeScript
4 | sidebar_label: TypeScript
5 | ---
6 |
7 | TypeScript support is built in to Noderize.
8 |
9 | Simply set/add `typescript` to the [`languages`](configuration-noderize.md#languages) option.
10 |
11 | If you are not using JavaScript, you may want to remove the `javascript` languages for better build times.
12 |
13 | [See example](https://github.com/Cretezy/noderize/tree/master/examples/basic-typescript).
14 |
15 | ## Entry
16 |
17 | When only using the `typescript` [`language`](configuration-noderize.md#languages) option, the [`bundles`](configuration-noderize.md#bundles) option is automatically set to enter at `src/index.ts`.
18 |
19 | If you are also using other languages but want your entry file to be a TypeScript file, simply set the [`bundles`](configuration-noderize.md#bundles) option to enter `src/index.ts`.
20 |
21 | ## Features
22 |
23 | * Decorators
24 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Messages:
11 | (this.list = ref)}>
12 |
30 | - {
15 | let message;
16 | switch (type) {
17 | case "join":
18 | case "leave":
19 | message = `${user} ${type === "join" ? "joined" : "left"}!`;
20 | break;
21 | case "message":
22 | const { text } = data;
23 | message = `${user}: ${text}`;
24 | break;
25 | }
26 | return { key: id, user, item: message };
27 | })}
28 | />
29 |
2 | 
3 |
4 | Noderize lets you create Node apps in less than 30 seconds.
5 |
6 |
7 | Documentation
8 |
9 |
10 |
27 |
28 |
42 |
43 | );
44 | }
45 | }
46 |
47 | module.exports = Users;
48 |
--------------------------------------------------------------------------------
/packages/scripts/src/scripts/start.js:
--------------------------------------------------------------------------------
1 | import spawn from "cross-spawn";
2 | import { getOptions } from "../options";
3 | import { appDirectory } from "../utils/path";
4 | import fs from "fs-extra";
5 | import { startLogger as log } from "../utils/logger";
6 |
7 | export default async args => {
8 | await start(getOptions(args));
9 | };
10 |
11 | export async function start(options, nodePath = process.argv[0]) {
12 | log.start("Starting...");
13 | console.log(); // Padding
14 |
15 | const startFileExists = await fs.exists(options.startFile);
16 | if (!startFileExists) {
17 | log.error("Start file does not exists.");
18 | return;
19 | }
20 |
21 | const args = [options.startFile, ...options.args._];
22 | const execArgv = ["-r", "source-map-support/register"];
23 |
24 | // Enable V8 debugger
25 | if (options.inspect) {
26 | args.unshift("inspect");
27 | }
28 | // Enable Chrome DevTools debugger
29 | if (options.inspectChrome) {
30 | execArgv.push(`--inspect=${options.inspectChrome}`);
31 | }
32 |
33 | const child = spawn(nodePath, [...execArgv, ...args], {
34 | cwd: appDirectory,
35 | stdio: "inherit"
36 | });
37 |
38 | child.on("exit", (code, signal) => {
39 | if (code !== null) {
40 | console.log(); // Padding
41 | if (code === 0) {
42 | log.success("Exited gracefully!");
43 | } else {
44 | log.warn(
45 | `Exited with code ${code} ${signal ? `and signal ${signal}` : ""}`
46 | );
47 | }
48 | }
49 | });
50 |
51 | return child;
52 | }
53 |
--------------------------------------------------------------------------------
/docs/website/siteConfig.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Copyright (c) 2017-present, Facebook, Inc.
3 | *
4 | * This source code is licensed under the MIT license found in the
5 | * LICENSE file in the root directory of this source tree.
6 | */
7 |
8 | /* List of projects/orgs using your project for the users page */
9 | // const users = [
10 | // {
11 | // caption: 'User1',
12 | // image: '/test-site/img/docusaurus.svg',
13 | // infoLink: 'https://www.facebook.com',
14 | // pinned: true,
15 | // },
16 | // ];
17 |
18 | const siteConfig = {
19 | title: "Noderize",
20 | tagline: " Create a Node app in less than 30 seconds.",
21 | url: "https://noderize.js.org",
22 | baseUrl: "/",
23 | headerLinks: [
24 | { doc: "introduction", label: "Docs" },
25 | // { blog: true, label: "Blog" },
26 | { href: "https://github.com/Cretezy/Noderize", label: "GitHub" }
27 | ],
28 | // users,
29 | headerIcon: "img/icon.svg",
30 | footerIcon: "img/icon.svg",
31 | favicon: "img/favicon/favicon.ico",
32 | colors: {
33 | primaryColor: "#3d434b",
34 | secondaryColor: "#fed766"
35 | },
36 |
37 | copyright: `Copyright © ${new Date().getFullYear()} Charles Crete`,
38 | organizationName: "Cretezy",
39 | projectName: "Noderize",
40 |
41 | highlight: {
42 | // Highlight.js theme to use for syntax highlighting in code blocks
43 | theme: "default"
44 | },
45 |
46 | scripts: ["https://buttons.github.io/buttons.js"],
47 | repoUrl: "https://github.com/Cretezy/Noderize",
48 | cname: "noderize.js.org",
49 | algolia: {
50 | apiKey: "ca0d50cdf7792b2eeaf3807f2a81cdde",
51 | indexName: "noderize"
52 | },
53 | };
54 |
55 | module.exports = siteConfig;
56 |
--------------------------------------------------------------------------------
/examples/chat-socket-react/server/src/index.js:
--------------------------------------------------------------------------------
1 | import { Server } from "http";
2 | import socketio from "socket.io";
3 | import uuid from "uuid";
4 | import { generateName } from "./name";
5 |
6 | const port = parseInt(process.env.PORT) || 3001;
7 | const http = Server();
8 | const io = socketio(http);
9 |
10 | const users = [];
11 |
12 | io.on("connection", socket => {
13 | // Get unique name
14 | let name;
15 | do {
16 | name = generateName();
17 | } while (users.includes(name));
18 |
19 | console.log(`${name} joined!`);
20 |
21 | // Send name to user
22 | socket.emit("setName", name);
23 |
24 | // Add user to user list
25 | users.push(name);
26 | // Update clients
27 | updateUserList();
28 | sendMessage({
29 | type: "join",
30 | user: name
31 | });
32 |
33 | socket.on("disconnect", () => {
34 | console.log(`${name} left!`);
35 | // Remove user from user list
36 | users.splice(users.indexOf(name), 1);
37 |
38 | // Update clients
39 | updateUserList();
40 | sendMessage({
41 | type: "leave",
42 | user: name
43 | });
44 | });
45 |
46 | socket.on("message", text => {
47 | // Send message to all users
48 | sendMessage({
49 | type: "message",
50 | user: name,
51 | data: { text }
52 | });
53 | });
54 | });
55 |
56 | function updateUserList() {
57 | // Update all user's local users list
58 | io.emit("updateUserList", users);
59 | }
60 |
61 | function sendMessage(message) {
62 | // Send message to all users (add unique id)
63 | io.emit("message", {
64 | ...message,
65 | id: uuid()
66 | });
67 | }
68 |
69 | http.listen(port, function() {
70 | console.log(`Listening on :${port}`);
71 | });
72 |
--------------------------------------------------------------------------------
/examples/chat-socket-react/web/public/index.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
11 |
12 |
13 |
22 |
29 |
41 |
30 |
33 | Who's Using This?
31 |This project is used by many folks
32 |{showcase}
34 | Are you using this project?
35 | 38 | Add your company 39 | 40 |
60 |
77 | );
78 | } else {
79 | return (
80 |
61 | Connected! You are:
65 |
68 |
76 |
69 | (this.messagesList = ref)}
72 | />
73 |
75 |
81 |
83 | );
84 | }
85 | }
86 | }
87 |
88 | export default App;
89 |
--------------------------------------------------------------------------------
/docs/docs/guides-publishing.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: guides-publishing
3 | title: Guide: Publishing
4 | sidebar_label: Publishing
5 | ---
6 |
7 | Noderize allows you to publish your module on npm with no additional step.
8 |
9 | Make sure to remove `"private": true` from your `package.json`.
10 |
11 | You simply have to build then publish to the registry:
12 |
13 | ```bash
14 | yarn build --env production
15 | yarn publish
16 | # or
17 | npm run build --env production
18 | npm publish
19 | ```
20 |
21 | When publishing to npm, you want to:
22 |
23 | * `clean`: Clean the output directory of any leftover files that you don't wish to publish.
24 | * `build`: Build your app/library. Prefer using the production [`env`](configuration-noderize.md#env) for cleaner publishing code.
25 | * `publish`: Use npm or Yarn to publish to the registry.
26 |
27 | If you want to preview what your package will look like instead, use the `pack` command (`yarn pack` or `npm pack`). This will create a `.tgz` file which is identical to what is published.
28 |
29 | ## Files
30 |
31 | By default, npm/Yarn will include these [files](https://docs.npmjs.com/files/package.json#files):
32 |
33 | * package.json
34 | * README
35 | * CHANGES / CHANGELOG / HISTORY
36 | * LICENSE / LICENCE
37 | * NOTICE
38 | * The file in the "main" field
39 |
40 | When using multiple bundles and/or static files, we must indicate that the whole `dist` folder should be published (and optionally include `src` for human-readable code). Add to your `package.json`:
41 |
42 | ```json
43 | "files": ["src", "dist"],
44 | ```
45 |
46 | ## Automatic Cleaning & Building
47 |
48 | To automate cleaning and building before publishing, you want to add the `prepack` script to your `package.json` like so:
49 |
50 | ```json
51 | "scripts": {
52 | "...": "...",
53 | "prepack": "noderize-scripts clean && noderize-scripts build --env production"
54 | }
55 | ```
56 |
57 | When using `yarn publish` or `npm publish`, it will first clean, then build, then publish.
58 |
59 | ## Fat bundle
60 |
61 | To generate a "fat bundle" with all your code and dependencies included, set [`includeExternal`](configuration-noderize.md#includeexternal) to `true`.
62 |
63 | This will add all the code in your output bundle, resulting in a large size, but making it portable.
64 |
65 | This is not recommended and should never be used when publishing to npm.
66 |
--------------------------------------------------------------------------------
/docs/docs/guides-firebase-functions.md:
--------------------------------------------------------------------------------
1 | ---
2 | id: guides-firebase-functions
3 | title: Guide: Firebase Cloud Functions
4 | sidebar_label: Firebase Cloud Functions
5 | ---
6 |
7 | To deploy Firebase Cloud Functions, we must:
8 |
9 | * Create a Firebase project
10 | * Create a Noderize app
11 | * Configure
12 |
13 | ## Requirements
14 |
15 | You must set up the [Firebase CLI](https://github.com/firebase/firebase-tools) before setting up Functions.
16 |
17 | Quick Firebase CLI setup:
18 |
19 | ```bash
20 | yarn global add firebase-tools
21 | # or
22 | npm install -g firebase-tools
23 |
24 | # then
25 | firebase login
26 | ```
27 |
28 | ## Project Setup
29 |
30 | Create a directory to be used as your project root (for Firebase). Set up Firebase using `firebase init`, and **do not** select the Functions options when creating.
31 |
32 | Next, [create](create.md) a Noderize project inside your project root called `functions`.
33 |
34 | > Note: You may change the directory name (defaults to `functions`) with the `functions.source` key in `firebase.json`.
35 |
36 | ## Setup
37 |
38 | You will need to add the Firebase-specific dependencies and scripts.
39 |
40 | First, add the dependencies:
41 |
42 | ```bash
43 | yarn add firebase-admin firebase-functions
44 | # or
45 | npm install firebase-admin firebase-functions
46 | ```
47 |
48 | Next, add these scripts to your `package.json`:
49 |
50 | ```json
51 | {
52 | "scripts": {
53 | "...": "...",
54 | "prepack": "noderize-scripts clean && noderize-scripts build --env production",
55 | "preserve": "npm run build",
56 | "serve": "firebase serve --only functions",
57 | "predeploy": "npm run prepack",
58 | "deploy": "firebase deploy --only functions",
59 | "preshell": "npm run build",
60 | "shell": "firebase experimental:functions:shell",
61 | "logs": "firebase functions:log"
62 | }
63 | }
64 | ```
65 |
66 | This will allow you to use the `serve`, `deploy`, `logs`, and `shell` command from Firebase.
67 |
68 | Done!
69 |
70 | ## Demo
71 |
72 | Replace `src/index.js` by:
73 |
74 | ```js
75 | import { https } from "firebase-functions";
76 |
77 | export const test = https.onRequest((req, res) => {
78 | res.send("Hello world!");
79 | });
80 | ```
81 |
82 | Then run `yarn serve` or `npm run serve`. You will see it build, then serve the function. Clicking the function link will show `Hello world!`.
83 |
--------------------------------------------------------------------------------
/packages/scripts/src/scripts/test.js:
--------------------------------------------------------------------------------
1 | import path from "path";
2 | import { appDirectory, getBinPath } from "../utils/path";
3 | import { execSync } from "child_process";
4 | import spawn from "cross-spawn";
5 | import { getOptions } from "../options";
6 | import cosmiconfig from "cosmiconfig";
7 | import merge from "lodash.merge";
8 | import { testLogger as log } from "../utils/logger";
9 |
10 | export default async (args, fullArgs) => {
11 | log.start("Testing...");
12 |
13 | const options = getOptions(null, "test");
14 |
15 | let jestConfig = {};
16 | try {
17 | // Load jest config
18 | const results = await cosmiconfig("jest").search();
19 |
20 | if (results) {
21 | jestConfig = results.config;
22 | }
23 | } catch (error) {
24 | log.error("Could not read Jest configuration.");
25 | log.error(error);
26 | }
27 |
28 | let isInGit;
29 | try {
30 | execSync("git rev-parse --is-inside-work-tree 2>/dev/null", {
31 | encoding: "utf8"
32 | });
33 | isInGit = true;
34 | } catch (error) {
35 | isInGit = false;
36 | }
37 |
38 | // Watch by default (when not in CI)
39 | if (
40 | !(
41 | process.env.CI ||
42 | args.includes("--ci") ||
43 | args.includes("--watchAll") ||
44 | args.includes("--watch") ||
45 | args.includes("--coverage")
46 | )
47 | ) {
48 | args.push(isInGit ? "--watch" : "--watchAll");
49 | }
50 |
51 | const extensions = [
52 | "js", // Must use js for Jest itself
53 | options.languages.typescript && "ts"
54 | ].filter(Boolean);
55 |
56 | const config = merge(
57 | {
58 | rootDir: appDirectory,
59 | roots: [`Connecting...
82 |