{"id":18262889,"url":"https://github.com/midwayjs/midway-code-mod","last_synced_at":"2025-04-09T01:24:45.763Z","repository":{"id":45242286,"uuid":"293410062","full_name":"midwayjs/midway-code-mod","owner":"midwayjs","description":"midway code operation","archived":false,"fork":false,"pushed_at":"2021-12-28T16:13:01.000Z","size":67,"stargazers_count":1,"open_issues_count":1,"forks_count":1,"subscribers_count":10,"default_branch":"master","last_synced_at":"2025-02-14T19:36:17.340Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/midwayjs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-07T03:11:58.000Z","updated_at":"2021-06-09T08:48:52.000Z","dependencies_parsed_at":"2022-09-10T17:42:02.029Z","dependency_job_id":null,"html_url":"https://github.com/midwayjs/midway-code-mod","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fmidway-code-mod","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fmidway-code-mod/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fmidway-code-mod/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/midwayjs%2Fmidway-code-mod/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/midwayjs","download_url":"https://codeload.github.com/midwayjs/midway-code-mod/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247954519,"owners_count":21024236,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T11:09:11.902Z","updated_at":"2025-04-09T01:24:45.736Z","avatar_url":"https://github.com/midwayjs.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Midway CodeMod\n\n代码操作工具，便捷修改 midway serverless项目的 config / configuration\n\n## Install\n```shell\n$ npm i @midwayjs/code-mod -S\n```\n\n## Usage\n\n```typescript\nimport { MidwayCodeMod, ProjectType } from '@midwayjs/code-mod';\n// 初始化\nconst codeMod = new MidwayCodeMod({\n  root,                           // 项目根目录\n  type: ProjectType.INTEGRATION,  // 默认为 NORMAL，一体化需要传 ProjectType.INTEGRATION\n  singleQuote: true               // 默认为 true，导出的代码中字符串是否使用单引号\n});\n\ncodeMod\n  .config()\n  .set('test', { // 设置某个key的多环境配置数据\n    local: 123,\n    default: 200,\n  })\n  .set('test2', {\n    local: 2123,\n    default: 2200,\n  });\n\n// 结束，输出\ncodeMod.done();\n```\n\n## Method\n### Config\n操作用户配置\n\n\n#### set\n\n设置配置\n```typescript\nset(key: string, multiEnvConfig: { [env: string]: any }): ConfigInstance;\n\n// demo:\ncodeMod.config().set(\n  'test',           // 配置的key\n  {                 // 多环境的配置\n    local: 123,\n    default: 200,\n  }\n)\n```\n#### get\n\n列举某环境下的所有配置\n```typescript\nget(key: string, env: string): any;\n// demo:\nconst value = codeMod.config().get('test', 'local');\nvalue === 123;\n```\n\n#### list\n\n列举某环境下的所有配置\n```typescript\nlist(env: string): {\n  [configName: string]: any;\n};\n// demo:\nconst configs = codeMod.config().list()\n```\n\n\n### Configuration\n\n操作IoC配置\n\n\n#### setImportConfigs\n\n设置IoC要加载的配置文件、配置文件目录\n\n```typescript\nsetImportConfigs(configList: string[]): ConfigurationInstance;\n\n// demo:\ncodeMod.configuration().setImportConfigs(['./config/']);\n```\n\n\n\n#### setImports\n\n设置IoC要加载的外部模块\n\n```typescript\nsetImports(configModuleList: string[]): ConfigurationInstance;\n\n// demo:\ncodeMod.configuration().setImports(['@midwayjs/faas-middleware-static-file']);\n```\n\n\n\n#### setProperty\n\n设置 Configuration Class 的属性\n\n```typescript\nsetProperty(propertyName: string, propertyInfo?: { decorator: string;}): ConfigurationInstance;\n\n// demo:\ncodeMod.configuration().setProperty('ctx', { decorator: 'Inject' });\n```\n\n\n\n#### setOnReady\n\n设置 Configuration setOnReady 的方法的代码\n\n```typescript\nsetOnReady(code: string): ConfigurationInstance;\n\n// demo:\ncodeMod.configuration().setOnReady('console.log(123)');\n```\n\n\n\n### Denpendency\n\n依赖处理\n\n#### addToFile\n\n添加依赖到某文件\n\n```typescript\naddToFile(\n  filePath: string,\n  denpencyInfo: {\n    moduleName: string;             // 模块名\n    name: string | string[];        // 导入的变量名，如果是数组，则认为是将内部的变量取出\n    isNamespace: boolean;           // 是否为 import * as xxx 的形式\n  }\n)\n\n// demo\ncodeMod.denpendency().addToFile(\n  codeMod.Variables.Configuraion.File,\n  {\n    moduleName: '@midwayjs/decorator',\n    name: ['Inject', 'Config', 'Logger'],\n  },\n)\n```\n\n\n\n#### addToPackage\n\n将依赖添加到package.json\n\n```typescript\naddToPackage(\n  moduleName: string,         // 模块名\n  version?: string,           // 版本，默认为 latest\n  isDevDependency?: boolean   // 是否为开发时依赖，默认为 false\n)\n\n// demo\ncodeMod.denpendency().addToPackage('@midwayjs/decorator', '^1.0.0')\n```\n\n\n\n### Plugin\n\n插件处理\n\n#### use\n\n使用某插件\n\n```typescript\nuse(pluginName: string, pluginOptions?: any)\n\n// demo\ncodeMod.plugin().use('test');\ncodeMod.plugin().use('test2', {\n  package: '@midwayjs/test'\n});\n```\n\n\n\n#### list\n\n列出来所有插件\n\n```typescript\nlist(): {\n  [pluginName: string]: any;\n};\n\n// demo\nconst plugins = codeMod.plugin().list();\nplugins.testPlugin === true;\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidwayjs%2Fmidway-code-mod","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmidwayjs%2Fmidway-code-mod","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmidwayjs%2Fmidway-code-mod/lists"}