{"id":18321631,"url":"https://github.com/bryanadamss/vue-cli-plugin-auto-alias","last_synced_at":"2025-04-05T22:32:26.631Z","repository":{"id":42784832,"uuid":"274326597","full_name":"BryanAdamss/vue-cli-plugin-auto-alias","owner":"BryanAdamss","description":"A vue-cli plugin that automatically sets aliases","archived":false,"fork":false,"pushed_at":"2022-03-26T23:18:32.000Z","size":339,"stargazers_count":3,"open_issues_count":9,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-18T15:58:07.837Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/BryanAdamss.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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-06-23T06:27:17.000Z","updated_at":"2020-08-26T06:18:57.000Z","dependencies_parsed_at":"2022-08-23T05:10:43.927Z","dependency_job_id":null,"html_url":"https://github.com/BryanAdamss/vue-cli-plugin-auto-alias","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fvue-cli-plugin-auto-alias","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fvue-cli-plugin-auto-alias/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fvue-cli-plugin-auto-alias/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BryanAdamss%2Fvue-cli-plugin-auto-alias/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BryanAdamss","download_url":"https://codeload.github.com/BryanAdamss/vue-cli-plugin-auto-alias/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247411234,"owners_count":20934650,"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-05T18:20:30.186Z","updated_at":"2025-04-05T22:32:26.344Z","avatar_url":"https://github.com/BryanAdamss.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vue-cli-plugin-auto-alias\n\n\u003e A vue-cli plugin that automatically sets aliases. According to the `rootDirName` and then auto generated directory alias\n\nEnglish | [中文](https://github.com/BryanAdamss/vue-cli-plugin-auto-alias/blob/master/README.zh-CN.md)\n\n## Install\n\n```sh\nvue add vue-cli-plugin-auto-alias\n\nor\n\nvue add auto-alias\n```\n\n## DefaultOptions\n\n```javascript\n// vue.config.js\nmodule.exports = {\n  pluginOptions: {\n    'vue-cli-plugin-auto-alias': {\n      // rooot dir for auto gen alias\n      rootDirName: 'src',\n      // letter-case\n      // support case: camelCase,capitalCase,constantCase,dotCase,headerCase,noCase,paramCase,pascalCase,pathCase,sentenceCase,snakeCase\n      // https://www.npmjs.com/package/change-case\n      case: 'pascalCase',\n      // custom alias\n      alias: {\n        // just like a normal resolve in Webpack\n        // test:path.resolve(__dirname,'test')\n      },\n    },\n  },\n}\n```\n\n## Examples\n\n- If your directory structure as follows\n\n```sh\n|---node_modules\n|---public\n|---src/    # rootDir\n    --- assets/\n    --- components/\n    --- router/\n    --- store/\n    --- views/\n    --- custom-dir/\n|--- package.json\n|--- vue.config.js\n```\n\n- and the options as follows\n\n```javascript\n// vue.config.js\nmodule.exports = {\n  pluginOptions: {\n    'vue-cli-plugin-auto-alias': {\n      // rooot dir for auto generated alias\n      rootDirName: 'src',\n      // letter-case\n      // support case: camelCase,capitalCase,constantCase,dotCase,headerCase,noCase,paramCase,pascalCase,pathCase,sentenceCase,snakeCase\n      // https://www.npmjs.com/package/change-case\n      case: 'pascalCase',\n      // custom alias\n      alias: {\n        Public: path.resolve(__dirname, 'public'),\n      },\n    },\n  },\n}\n```\n\n- and you will get webpack alias as follows\n\n```javascript\n// vue inspect \u003e output.js\n{\n   resolve: {\n    alias: {\n      '@': 'D:\\\\Workspace\\\\web-front-report\\\\src',\n      vue$: 'vue/dist/vue.runtime.esm.js',\n\n      // according to the rootDirName auto generated alias\n      Assets: 'D:\\\\Workspace\\\\web-front-report\\\\src\\\\assets',\n      Components: 'D:\\\\Workspace\\\\web-front-report\\\\src\\\\components',\n      Router: 'D:\\\\Workspace\\\\web-front-report\\\\src\\\\router',\n      Store: 'D:\\\\Workspace\\\\web-front-report\\\\src\\\\store',\n      CustomDir: 'D:\\\\Workspace\\\\web-front-report\\\\src\\\\custom-dir',\n\n      // custom alias\n      Public: 'D:\\\\Workspace\\\\web-front-report\\\\public\n    },\n}\n```\n\n## NPM\n\n- [vue-cli-plugin-auto-alias](https://www.npmjs.com/package/vue-cli-plugin-auto-alias)\n- [@bryanadamss/drawing-board](https://www.npmjs.com/package/@bryanadamss/drawing-board)\n- [@bryanadamss/num2chn](https://www.npmjs.com/package/@bryanadamss/num2chn)\n- [ant-color-converter](https://www.npmjs.com/package/ant-color-converter)\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n## 📝 License\n\nCopyright © 2020 [BryanAdamss@foxmail.com](https://github.com/BryanAdamss).\u003cbr /\u003e\nThis project is [MIT](https://github.com/kefranabg/readme-md-generator/blob/master/LICENSE) licensed.\n\n## Contributors ✨\n\nThanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003ctd align=\"center\"\u003e\u003ca href=\"https://bryanadamss.github.io/\"\u003e\u003cimg src=\"https://avatars3.githubusercontent.com/u/7441504?v=4\" width=\"64px;\" alt=\"\"/\u003e\u003cbr /\u003e\u003csub\u003e\u003cb\u003eGuangHui\u003c/b\u003e\u003c/sub\u003e\u003c/a\u003e\u003cbr /\u003e\u003ca href=\"#projectManagement-BryanAdamss\" title=\"Project Management\"\u003e📆\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n\u003c!-- markdownlint-enable --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\nThis project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryanadamss%2Fvue-cli-plugin-auto-alias","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbryanadamss%2Fvue-cli-plugin-auto-alias","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbryanadamss%2Fvue-cli-plugin-auto-alias/lists"}