feat: init base module

This commit is contained in:
xion 2024-06-22 23:47:43 +08:00
commit 35f1182aec
18 changed files with 13328 additions and 0 deletions

1
.gitignore vendored Normal file
View File

@ -0,0 +1 @@
node_modules

1
.npmrc Normal file
View File

@ -0,0 +1 @@
@abearxiong:registry=https://npm.pkg.github.com

4
app.config.json5 Normal file
View File

@ -0,0 +1,4 @@
{
port: 4000, // 端口
tokenSecret: 'x2024',
}

2336
dist/app.cjs vendored Normal file

File diff suppressed because one or more lines are too long

213
jest.config.ts Normal file
View File

@ -0,0 +1,213 @@
// For a detailed explanation regarding each configuration property, visit:
// https://jestjs.io/docs/en/configuration.html
import type { Config } from 'jest';
import { defaults } from 'jest-config';
const config: Config = {
// All imported modules in your tests should be mocked automatically
// automock: false,
// Stop running tests after `n` failures
// bail: 0,
globals: {
window: {},
},
// The directory where Jest should store its cached dependency information
// cacheDirectory: "/private/var/folders/y3/bq7hhg1x02x_3xqrx11sql840000gn/T/jest_dx",
// Automatically clear mock calls and instances between every test
clearMocks: true,
// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,
// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: undefined,
// The directory where Jest should output its coverage files
coverageDirectory: 'coverage',
// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],
// Indicates which provider should be used to instrument code for coverage
// coverageProvider: "babel",
// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],
// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: undefined,
// A path to a custom dependency extractor
// dependencyExtractor: undefined,
// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,
// Force coverage collection from ignored files using an array of glob patterns
// forceCoverageMatch: [],
// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: undefined,
// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: undefined,
// A set of global variables that need to be available in all test environments
// globals: {},
// The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers.
// maxWorkers: "50%",
// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],
// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "json",
// "jsx",
// "ts",
// "tsx",
// "node"
// ],
// A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
// moduleNameMapper: {},
// moduleNameMapper: {
// '(.*)': ['<rootDir>/$1', '<rootDir>/$1', '<rootDir>/$1'],
// },
// moduleNameMapper: {
// '@/(.*)': ['<rootDir>/$1', '<rootDir>/$1', '<rootDir>/$1'],
// },
// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],
// Activates notifications for test results
// notify: false,
// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",
// A preset that is used as a base for Jest's configuration
// preset: undefined,
// preset: 'ts-jest',
preset: 'ts-jest/presets/default-esm',
// transform: {
// '^.+\\.ts?$': 'babel-jest',
// },
transform: {
// '^.+\\.(ts|js)x?$': 'ts-jest',
'^.+\\.(ts|js)x?$': ['ts-jest', { useESM: true }],
},
// "testRegex": "/test/.*\\.(test|spec)\\.(ts)$",
// Run tests from one or more projects
// projects: undefined,
// Use this configuration option to add custom reporters to Jest
// reporters: undefined,
// Automatically reset mock state between every test
// resetMocks: false,
// Reset the module registry before running each individual test
// resetModules: false,
// A path to a custom resolver
// resolver: undefined,
// Automatically restore mock state between every test
// restoreMocks: false,
// The root directory that Jest should scan for tests and modules within
// rootDir: undefined,
// A list of paths to directories that Jest should use to search for files in
// roots: [
// "<rootDir>"
// ],
// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",
// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],
// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],
// The number of seconds after which a test is considered as slow and reported as such in the results.
// slowTestThreshold: 5,
// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],
// The test environment that will be used for testing
// testEnvironment: 'node',
testEnvironment: 'node',
// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},
// Adds a location field to test results
// testLocationInResults: false,
// The glob patterns Jest uses to detect test files
testMatch: ['**/__tests__/**/*.[jt]s?(x)', '**/?(*.)+(spec|test).[tj]s?(x)'],
// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
testPathIgnorePatterns: [
'/node_modules/',
'<rootDir>/node_modules/(?!(quill-mention)/)',
],
// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],
// This option allows the use of a custom results processor
// testResultsProcessor: undefined,
// This option allows use of a custom test runner
// testRunner: "jasmine2",
// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
// testURL: "http://localhost",
// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
// timers: "real",
// A map from regular expressions to paths to transformers
// transform: undefined,
// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "/node_modules/",
// "\\.pnp\\.[^\\/]+$"
// ],
// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,
// Indicates whether each individual test should be reported during the run
// verbose: undefined,
// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],
// Whether to use watchman for file crawling
// watchman: true,
};
module.exports = config;

6528
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

57
package.json Normal file
View File

@ -0,0 +1,57 @@
{
"name": "code-flow",
"version": "1.0.0",
"description": "code的flow流程成图",
"type": "module",
"main": "index.js",
"scripts": {
"watch": "cross-env ENV=production webpack --mode=production --watch",
"dev": "cross-env NODE_ENV=development nodemon -e js,cjs,mjs --exec node dist/app.cjs",
"test": "NODE_ENV=development node --experimental-vm-modules node_modules/jest/bin/jest.js --detectOpenHandles ",
"build": "cross-env ENV=production webpack --mode=production",
"build:sh": "cross-env webpack --mode=production -c ./webpack.shell.config.cjs",
"deploy": "scp ./dist/app.js light:~/apps/x2025/back-end",
"deploy:sh": "",
"clean": "rm -rf dist",
"reload": "ssh light pm2 restart x2025"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"@abearxiong/router": "^0.0.1-alpha.4",
"@abearxiong/use-config": "^0.0.1",
"dayjs": "^1.11.11",
"json5": "^2.2.3",
"jsonwebtoken": "^9.0.2",
"lodash-es": "^4.17.21",
"mongodb": "^6.7.0",
"mongoose": "^8.4.3",
"nanoid": "^5.0.7",
"socket.io": "^4.7.5"
},
"devDependencies": {
"@types/crypto-js": "^4.2.2",
"@types/jest": "^29.5.12",
"@types/jsonwebtoken": "^9.0.6",
"@types/lodash-es": "^4.17.12",
"@types/node": "^20.14.8",
"@types/superagent": "^8.1.7",
"@types/supertest": "^6.0.2",
"@types/webpack-env": "^1.18.5",
"concurrently": "^8.2.2",
"copy-webpack-plugin": "^12.0.2",
"cross-env": "^7.0.3",
"fork-ts-checker-webpack-plugin": "^9.0.2",
"jest": "^29.7.0",
"nodemon": "^3.1.4",
"supertest": "^7.0.0",
"ts-jest": "^29.1.5",
"ts-loader": "^9.5.1",
"ts-node": "^10.9.2",
"typescript": "^5.5.2",
"webpack": "^5.92.1",
"webpack-cli": "^5.1.4",
"webpack-node-externals": "^3.0.0"
}
}

2
readme.md Normal file
View File

@ -0,0 +1,2 @@
code的flow流程成图

45
src/admin/index.ts Normal file
View File

@ -0,0 +1,45 @@
// admin 需要最后运行并在route中进行过滤。
import { Route } from '@abearxiong/router';
import { router } from '../modules/router.ts';
export const getRouterList = new Route('admin', 'getRouterList');
getRouterList.run = async (ctx) => {
// ctx.body = router.getList().filter((r) => r.path.startsWith('admin'));
ctx.body = router.getList().filter((r) => r.path.startsWith('admin'));
return ctx;
};
router.add(getRouterList);
// remove router
export const removeRouter = new Route('admin', 'removeRouter');
removeRouter.run = async (ctx) => {
const { path, key } = ctx.query;
router.remove({path, key});
ctx.body = 'success';
return ctx;
}
router.add(removeRouter);
// add router
export const addRouter = new Route('admin', 'addRouter');
addRouter.run = async (ctx) => {
const { path, key } = ctx.query;
router.add(new Route(path, key));
ctx.body = 'success';
return ctx;
}
router.add(addRouter);
// update router
export const updateRouter = new Route('admin', 'updateRouter');
updateRouter.run = async (ctx) => {
const { path, key } = ctx.query;
// router.update(path, key);
ctx.body = 'success';
return ctx;
}
router.add(updateRouter);

13
src/app.ts Normal file
View File

@ -0,0 +1,13 @@
import { useConfig } from '@abearxiong/use-config';
import { handleMessage } from './route.ts';
import { server as routerServer } from './modules/router.ts';
import http from 'http';
const config = useConfig();
routerServer.setHandle(handleMessage);
const server = http.createServer(routerServer.callback());
server.listen(config.port, () => {
console.log(`Server running at http://localhost:${config.port}/`);
});

5
src/modules/router.ts Normal file
View File

@ -0,0 +1,5 @@
import { QueryRouter, Server } from '@abearxiong/router';
export const router = new QueryRouter();
export const server = new Server({
path: '/api/router',
});

19
src/route.ts Normal file
View File

@ -0,0 +1,19 @@
import { router } from './modules/router.ts';
import './test/index.ts';
import './admin/index.ts';
type Message = {
path: string;
key?: string;
};
export const handleMessage = async function (m: Message) {
console.log('message', m);
const res = await router.parse(m);
const { code, body, message } = res;
console.log('response', res);
return { code, data: body, message };
};

9
src/test/index.ts Normal file
View File

@ -0,0 +1,9 @@
import { router } from '../modules/router.ts';
import { Route } from '@abearxiong/router';
const getList = new Route('test', 'getList');
getList.run = async (ctx) => {
ctx.body = 'test';
return ctx;
};
router.add(getList);

53
tsconfig.json Normal file
View File

@ -0,0 +1,53 @@
{
"compilerOptions": {
"module": "nodenext",
"target": "esnext",
"noImplicitAny": false,
"outDir": "./dist",
"sourceMap": false,
"allowJs": true,
"newLine": "LF",
"baseUrl": "./",
"typeRoots": [
"node_modules/@types",
"src/@types"
],
"declaration": true,
"noEmit": false,
"allowImportingTsExtensions": true,
"emitDeclarationOnly": true,
"moduleResolution": "NodeNext",
"experimentalDecorators": true,
"emitDecoratorMetadata": true,
"esModuleInterop": true,
"paths": {
"@/*": [
"src/*"
],
"*": [
"types/*"
]
}
},
"include": [
"typings.d.ts",
"src/**/*.ts"
],
"exclude": [
"node_modules",
"dist",
"src/**/*.test.ts",
"webpack.config.cjs",
],
"ts-node": {
// Do not forget to `npm i -D tsconfig-paths`
"require": [
// "tsconfig-paths/register"
],
// "skipIgnore": true,
"ignore": [
// "(?:^|/)node_modules/",
// "(?:^|/)node_modules/(?!.*abearxiong)" //abearxiongnode_modules
]
}
}

16
typings.d.ts vendored Normal file
View File

@ -0,0 +1,16 @@
type SimpleObject = {
[key: string | number]: any;
};
declare module 'koa2-cors';
declare module 'cors-anywhere';
// mockjs http://mockjs.com/
declare module 'mockjs';
// type CTX: ParameterizedContext<any, DefaultContext & Router.IRouterParamContext<any, DefaultContext>>
// declare module 'jsonwebtoken';
// declare var global: NodeJS.Global & typeof globalThis;

71
webpack.config.cjs Normal file
View File

@ -0,0 +1,71 @@
/* eslint-disable */
const path = require('path');
const webpack = require('webpack');
// const nodeExternals = require('webpack-node-externals');
const pkgs = require('./package.json');
const CopyPlugin = require('copy-webpack-plugin');
/** 解决esmodule中noEmit报错问题 */
const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
const ENV = process.env.ENV;
const plugins = [
new ForkTsCheckerWebpackPlugin(),
];
if (ENV === 'init') {
plugins.push(
new CopyPlugin({
patterns: [{ from: 'src/app.config.json5', to: 'app.config.json5' }],
}),
);
}
module.exports = {
mode: 'production',
entry: path.join(__dirname, './src/app.ts'),
target: 'node',
// devtool: 'source-map',
output: {
path: path.join(__dirname, './dist'),
// path: path.join(__dirname, './dev-package'),
// filename: 'app.mjs',
filename: 'app.cjs',
// module: true,
// chunkFormat: 'module',
},
// experiments: {
// outputModule: true,
// },
optimization: {
minimize: false,
},
module: {
rules: [
{
test: /\.tsx?$/,
exclude: '/node_modules/',
use: {
loader: 'ts-loader',
options: {
allowTsInNodeModules: true,
},
},
},
],
},
resolve: {
extensions: ['.ts', '.js'],
alias: {
'@': path.join(__dirname, './src'),
"hexoid": "hexoid/dist/index.js",
},
},
// externals: [
// // nodeExternals(),
// ],
externals: {
sequelize: 'commonjs sequelize',
'socket.io': 'commonjs socket.io',
},
plugins: [...plugins],
node: {},
};

59
webpack.shell.config.cjs Normal file
View File

@ -0,0 +1,59 @@
/* eslint-disable */
const path = require('path');
const webpack = require('webpack');
const nodeExternals = require('webpack-node-externals');
const pkgs = require('./package.json');
const glob = require('glob');
const ForkTsCheckerWebpackPlugin = require('fork-ts-checker-webpack-plugin');
const plugins = [new ForkTsCheckerWebpackPlugin()];
module.exports = {
// mode: 'production',
// entry: path.join(__dirname, './src/app.ts'),
entry: glob.sync('./src/scripts/*.ts').reduce((entries, p) => {
const name = path.basename(p, '.ts'); //获取路径的文件名 aaa/bbb.js => bbb
return { ...entries, [name]: p };
}, {}),
target: 'node',
output: {
path: path.join(__dirname, './dist/scripts'),
module: true,
chunkFormat: 'module',
},
experiments: {
outputModule: true,
},
optimization: {
minimize: false,
},
module: {
rules: [
{
test: /\.tsx?$/,
exclude: '/node_modules/',
use: {
loader: 'ts-loader',
options: {
allowTsInNodeModules: true,
},
},
},
],
},
resolve: {
extensions: ['.ts', '.js'],
alias: {
'@': path.join(__dirname, './src'),
hexoid: 'hexoid/dist/index.js',
},
},
externals: [
nodeExternals({
allowlist: ['/@abearxiong*/'],
}),
],
plugins: [...plugins],
node: {},
};

3896
yarn.lock Normal file

File diff suppressed because it is too large Load Diff