@router-cli/react-router-dev
Version:
File based routing cli for react-router-dom.
334 lines (333 loc) • 16.7 kB
JavaScript
"use strict";
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __values = (this && this.__values) || function(o) {
var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
if (m) return m.call(o);
if (o && typeof o.length === "number") return {
next: function () {
if (o && i >= o.length) o = void 0;
return { value: o && o[i++], done: !o };
}
};
throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
};
var __read = (this && this.__read) || function (o, n) {
var m = typeof Symbol === "function" && o[Symbol.iterator];
if (!m) return o;
var i = m.call(o), r, ar = [], e;
try {
while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
}
catch (error) { e = { error: error }; }
finally {
try {
if (r && !r.done && (m = i["return"])) m.call(i);
}
finally { if (e) throw e.error; }
}
return ar;
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Generator = void 0;
var fs = __importStar(require("fs"));
var fast_glob_1 = __importDefault(require("fast-glob"));
var loggingUtils = __importStar(require("../utils/logging"));
var strings_1 = require("./utils/strings");
var code_scanning_1 = require("./utils/code-scanning");
var code_gen_1 = require("./code-gen");
var utils_1 = require("./code-gen/utils");
var child_process_1 = require("child_process");
var path_1 = __importDefault(require("path"));
var Generator = (function () {
function Generator(config, verbose) {
var _this = this;
this.verboseLog = function (section, log) {
if (_this._verbose) {
loggingUtils.verboseLog(section, log);
}
};
this._currentOutput = fs.existsSync(config.output) ? fs.readFileSync(config.output, 'utf-8') : "";
this._verbose = verbose;
this._config = config;
this._config.source = (0, strings_1.trimCharEnd)(this._config.source, "/");
this._config.sourceAlias = this._config.sourceAlias ? (0, strings_1.trimCharEnd)(this._config.source, "/") : undefined;
}
Generator.prototype.generate = function () {
return __awaiter(this, void 0, void 0, function () {
var routes, codeOutput;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4, this.discoverRouteFiles()];
case 1:
routes = _a.sent();
codeOutput = this.generateCode(routes);
return [4, this.writeFile(codeOutput)];
case 2:
_a.sent();
return [2];
}
});
});
};
Generator.prototype.generateCode = function (routes) {
var e_1, _a, e_2, _b;
var layouts = {
imports: [],
routes: [],
};
var pages = {
imports: [],
routes: [],
};
var imports = [];
var exports = [];
var appRouteComponents = {
app: false,
notFound: false,
error: false,
pending: false,
};
try {
for (var _c = __values(routes.pages.values()), _d = _c.next(); !_d.done; _d = _c.next()) {
var item = _d.value;
pages.imports.push("\"".concat(item.typedRoute, "\": () => import(\"").concat(item.importSource, "\").then(x => x.default)"));
pages.routes.push("\"".concat(item.typedRoute, "\": ExtractImportType<typeof ").concat(code_gen_1.CODE_NAMING.pages, "[\"").concat(item.typedRoute, "\"]>"));
}
}
catch (e_1_1) { e_1 = { error: e_1_1 }; }
finally {
try {
if (_d && !_d.done && (_a = _c.return)) _a.call(_c);
}
finally { if (e_1) throw e_1.error; }
}
try {
for (var _e = __values(routes.layouts.values()), _f = _e.next(); !_f.done; _f = _e.next()) {
var item = _f.value;
layouts.imports.push("\"".concat(item.typedRoute, "\": () => import(\"").concat(item.importSource, "\").then(x => x.default)"));
layouts.routes.push("\"".concat(item.typedRoute, "\": ExtractImportType<typeof ").concat(code_gen_1.CODE_NAMING.layouts, "[\"").concat(item.typedRoute, "\"]>"));
}
}
catch (e_2_1) { e_2 = { error: e_2_1 }; }
finally {
try {
if (_f && !_f.done && (_b = _e.return)) _b.call(_e);
}
finally { if (e_2) throw e_2.error; }
}
if (routes.appRoutes.app) {
imports.push("import App from \"".concat(routes.appRoutes.app, "\";"));
appRouteComponents.app = true;
}
if (routes.appRoutes.notFound) {
imports.push("import NotFound from \"".concat(routes.appRoutes.notFound, "\";"));
appRouteComponents.notFound = true;
}
if (routes.appRoutes.error) {
imports.push("import DefaultErrorComponent from \"".concat(routes.appRoutes.error, "\";"));
exports.push("export { DefaultErrorComponent };");
appRouteComponents.error = true;
}
if (routes.appRoutes.pending) {
imports.push("import DefaultPendingComponent from \"".concat(routes.appRoutes.pending, "\";"));
exports.push("export { DefaultPendingComponent };");
appRouteComponents.pending = true;
}
var routerType = "createBrowserRouter";
if (this._config.type === "hash") {
routerType = "createHashRouter";
}
if (this._config.type === "memory") {
routerType = "createMemoryRouter";
}
return (0, code_gen_1.populateTemplate)({
layouts: layouts,
pages: pages,
appRouteComponents: appRouteComponents,
imports: imports,
exports: exports,
routerType: routerType
});
};
Generator.prototype.discoverRouteFiles = function () {
return __awaiter(this, void 0, void 0, function () {
var pagesPromise, layoutsPromise, reservedRoutesPromise, _a, pages, layouts, reservedRoutes, appRoutes, app, relativeSource, notFound, relativeSource, error, relativeSource, pending, relativeSource;
var _this = this;
return __generator(this, function (_b) {
switch (_b.label) {
case 0: return [4, (0, fast_glob_1.default)([
this._config.source + '/**/?($)[\\w-]*.page.tsx'
], { onlyFiles: true })];
case 1:
pagesPromise = _b.sent();
return [4, (0, fast_glob_1.default)([
this._config.source + '/**/_layout.tsx',
], { onlyFiles: true })];
case 2:
layoutsPromise = _b.sent();
return [4, (0, fast_glob_1.default)([
this._config.source + '/_app.tsx',
this._config.source + '/_404.tsx',
this._config.source + '/_error.tsx',
this._config.source + '/_pending.tsx',
], { onlyFiles: true })];
case 3:
reservedRoutesPromise = _b.sent();
return [4, Promise.all([
pagesPromise,
layoutsPromise,
reservedRoutesPromise
])];
case 4:
_a = __read.apply(void 0, [_b.sent(), 3]), pages = _a[0], layouts = _a[1], reservedRoutes = _a[2];
pages.sort(function (a, b) { return a.split("/").length - b.split("/").length || a.localeCompare(b); });
layouts.sort(function (a, b) { return a.split("/").length - b.split("/").length; });
this.verboseLog("discovered routes", function () {
console.log("Pages");
pages.forEach(function (x) { return console.log(x); });
console.log("Layouts");
layouts.forEach(function (x) { return console.log(x); });
console.log("Reserved");
reservedRoutes.forEach(function (x) { return console.log(x); });
});
appRoutes = {};
if (reservedRoutes.length) {
app = reservedRoutes.find(function (x) { return x.endsWith("/_app.tsx"); });
if (app) {
relativeSource = this.getRelativeSource(app);
appRoutes.app = this.getImportSource(relativeSource);
}
notFound = reservedRoutes.find(function (x) { return x.endsWith("/_404.tsx"); });
if (notFound) {
relativeSource = this.getRelativeSource(notFound);
appRoutes.notFound = this.getImportSource(relativeSource);
}
error = reservedRoutes.find(function (x) { return x.endsWith("/_error.tsx"); });
if (error) {
relativeSource = this.getRelativeSource(error);
appRoutes.error = this.getImportSource(relativeSource);
}
pending = reservedRoutes.find(function (x) { return x.endsWith("/_pending.tsx"); });
if (pending) {
relativeSource = this.getRelativeSource(pending);
appRoutes.pending = this.getImportSource(relativeSource);
}
}
return [2, {
pages: new Map(pages.map(function (item) {
var data = _this.processRoute(item, "page");
return [data.fullRoute, data];
})),
layouts: new Map(layouts.map(function (item) {
var data = _this.processRoute(item, "layout");
return [data.fullRoute, data];
})),
appRoutes: appRoutes
}];
}
});
});
};
Generator.prototype.processRoute = function (srcPath, type) {
var relativeSource = this.getRelativeSource(srcPath);
var importSource = this.getImportSource(relativeSource);
var typedRoute = "/" + ((0, code_scanning_1.transformRoute)(relativeSource, this._config.hiddenDirectories) || "") + (type === "layout" ? "/layout" : "");
var fullRoute = typedRoute.replace("/$", "/:").replace("/$catchAll", "/*");
return {
fullRoute: fullRoute,
typedRoute: typedRoute,
importSource: importSource,
};
};
Generator.prototype.getImportSource = function (relativeSrc) {
var _a = this._config, sourceAlias = _a.sourceAlias, source = _a.source;
return "".concat((sourceAlias || source), "/").concat((0, utils_1.trimExt)(relativeSrc));
};
Generator.prototype.getRelativeSource = function (srcPath) {
return srcPath.slice(this._config.source.length + 1, srcPath.length);
};
Generator.prototype.writeFile = function (output) {
if (this._currentOutput !== output && output) {
console.log("Writing Routes File.");
fs.writeFileSync(this._config.output, output);
if (this._config.formatter) {
if (this._config.formatter === "prettier") {
var prettier = path_1.default.resolve('./node_modules/.bin/prettier');
if (fs.existsSync(prettier)) {
(0, child_process_1.exec)("".concat(prettier, " --write --cache ").concat(this._config.output));
}
}
if (this._config.formatter === "eslint") {
var eslint = path_1.default.resolve('./node_modules/.bin/eslint');
if (fs.existsSync(eslint)) {
(0, child_process_1.exec)("".concat(eslint, " --format ").concat(this._config.output));
}
}
}
this._currentOutput = output;
}
};
return Generator;
}());
exports.Generator = Generator;