{"id":18712411,"url":"https://github.com/serkodev/nuxt-workspace","last_synced_at":"2026-05-04T08:40:00.228Z","repository":{"id":211652904,"uuid":"729671953","full_name":"serkodev/nuxt-workspace","owner":"serkodev","description":"A Nuxt module integrating workspace paths into Nuxt config of monorepo","archived":false,"fork":false,"pushed_at":"2023-12-10T14:23:13.000Z","size":97,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-14T20:37:25.433Z","etag":null,"topics":["monorepo","nuxt","nuxt-module","vue","workspace"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/serkodev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-10T00:57:36.000Z","updated_at":"2023-12-10T14:19:59.000Z","dependencies_parsed_at":null,"dependency_job_id":"31935984-14a2-4d5d-bc9d-3e05e1b21d74","html_url":"https://github.com/serkodev/nuxt-workspace","commit_stats":null,"previous_names":["serkodev/nuxt-workspace"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/serkodev/nuxt-workspace","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fnuxt-workspace","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fnuxt-workspace/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fnuxt-workspace/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fnuxt-workspace/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/serkodev","download_url":"https://codeload.github.com/serkodev/nuxt-workspace/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/serkodev%2Fnuxt-workspace/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32600967,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-03T22:12:39.696Z","status":"online","status_checked_at":"2026-05-04T02:00:06.625Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["monorepo","nuxt","nuxt-module","vue","workspace"],"created_at":"2024-11-07T12:42:43.197Z","updated_at":"2026-05-04T08:40:00.200Z","avatar_url":"https://github.com/serkodev.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Nuxt Workspace\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n\nA Nuxt module integrating workspace paths into Nuxt config of monorepo\n\n\u003e [!NOTE]\n\u003e This project is in beta. Use under your own risk, but feel free to test, make pull request and improve this project.\n\n## Features\n\n- Seamless integration of `#workspace` in any path of the Nuxt config\n- Customizable placeholder option to suit your needs\n- Ability to selectively exclude specific configurations from being replaced\n\n## Why\n\nNuxt originally provides a [`typescript.includeWorkspace`](https://nuxt.com/docs/api/nuxt-config#includeworkspace) config, but it only includes all workspace files. This can cause interference between different packages in a monorepo, preventing the completion of [`typecheck`](https://nuxt.com/docs/api/commands/typecheck).\n\nAfter using this `nuxt-workspace` module, you can use `#workspace/*.d.ts` in the `typescript.tsConfig.include` configuration to customize the workspace pattern you want to include and also you can also use it in all other Nuxt configuration areas.\n\n## Setup\n\n```bash\n# Using pnpm\npnpm add -D nuxt-workspace\n\n# Using yarn\nyarn add --dev nuxt-workspace\n\n# Using npm\nnpm install --save-dev nuxt-workspace\n```\n\n## Usage\n\nAfter adding `nuxt-workspace` to your nuxt config modules, you can use `#workspace` as path in your `nuxt.config.ts`. It will auto replace the placeholder with the [`workspaceDir`](https://nuxt.com/docs/api/nuxt-config#workspacedir).\n\n```js\nexport default defineNuxtConfig({\n  modules: [\n    'nuxt-workspace'\n  ],\n  typescript: {\n    tsConfig: {\n      include: [\n        '#workspace/*.d.ts'\n      ],\n    },\n  },\n  components: [\n    { path: '#workspace/packages/foo/components' }\n  ]\n})\n```\n\n## Configuration\n\nYou can configure Nuxt Workspace with the `workspace` property in your nuxt.config file.\n\n### `placeholder`\n\n- Type: `string`\n- Default: `#workspace`\n\nAllows you to customize the placeholder used for workspace path substitution.\n\n```ts\nexport default defineNuxtConfig({\n  workspace: {\n    placeholder: '@my-workspace'\n  },\n  // Now you can use to `@my-workspace` in your config\n  typescript: {\n    tsConfig: {\n      include: [\n        '@my-workspace/*.d.ts'\n      ]\n    }\n  }\n})\n```\n\n### `ignoreObjectPaths`\n\n- Type: `string[]`\n- Default: `[]`\n\nAllows you to selectively exclude specific configurations from being replaced.\n\n```ts\nexport default defineNuxtConfig({\n  workspace: {\n    ignoreObjectPaths: [\n      'app.head.title'\n    ]\n  },\n  app: {\n    head: {\n      title: '#workspace' // this config will not been replaced\n    }\n  }\n})\n```\n\nIgnore object paths with Object or Array\n\n```ts\nexport default defineNuxtConfig({\n  workspace: {\n    ignoreObjectPaths: [\n      'foo.someArray[1]',\n      'foo.someObject',\n    ]\n  },\n  foo: {\n    someArray: [\n      '#workspace/foo',\n      '#workspace/bar', // ignore replacement\n    ],\n\n    // ignore replacement for all configs in this object\n    someObject: {\n      'foo': '#workspace',\n      'bar': '#workspace',\n    }\n  },\n})\n```\n\n## Development\n\n```bash\n# Install dependencies\npnpm install\n\n# Generate type stubs\npnpm run dev:prepare\n\n# Develop with the playground\npnpm run dev\n\n# Build the playground\npnpm run dev:build\n\n# Run ESLint\npnpm run lint\n\n# Run Vitest\npnpm run test\npnpm run test:watch\n\n# Release new version\npnpm run release\n```\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-workspace/latest.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-version-href]: https://npmjs.com/package/nuxt-workspace\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-workspace.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[npm-downloads-href]: https://npmjs.com/package/nuxt-workspace\n\n[license-src]: https://img.shields.io/npm/l/nuxt-workspace.svg?style=flat\u0026colorA=18181B\u0026colorB=28CF8D\n[license-href]: https://npmjs.com/package/nuxt-workspace\n\n[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserkodev%2Fnuxt-workspace","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fserkodev%2Fnuxt-workspace","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fserkodev%2Fnuxt-workspace/lists"}