This package is unstable! Documentation formatting could change in the future. See something that you think should be different? Open an issue on github and help shape this plugin.

Prerequisites

• Have an existing nx workspace containing an Nx plugin project. For creating this, see nrwl's documentation.

Installation

NPM

npm i --save-dev @nx-dotnet/nxdoc

PNPM

pnpm i --save-dev @nx-dotnet/nxdoc

Yarn

yarn add --dev @nx-dotnet/nxdoc

Generate Documentation

Generate markdown docs in the /docs folder of your repository for each plugin in the workspace

npx nx g @nx-dotnet/nxdoc:generate-docs --outputPath docs

2.4.1 (2024-07-30)

🩹 Fixes

• repo: published packages should include resolved versions (#879)

❤️ Thank You

• Craigory Coppola @AgentEnder

2.4.0 (2024-07-29)

🚀 Features

• nx-ghpages: intuit directory and remote when possible (#875)

❤️ Thank You

• Craigory Coppola @AgentEnder

2.3.2 (2024-07-28)

🩹 Fixes

• dotnet: serve should work with dotnet 8 (#873)
• repo: use yarn in release workflow (ebfae21)

❤️ Thank You

• Craigory Coppola @AgentEnder

2.3.1 (2024-07-28)

Bug Fixes

• core: read dependencies via dotnet list reference (071f557)
• core: read js lib defaults when generating js lib (c8bac90)
• core: version suffix is a string (80bcb04)

2.3.0 (2024-07-27)

Bug Fixes

• core: remove warning "Project 'xxx' contains extension with invalid name (type)." (#831) (4c19278)
• nx-ghpages: syncWithBaseBranch should be a boolean option (1306ceb)

Features

• core: update to nx 19 (#857) (d349830)
• nx-ghpages: add support for passing GH_TOKEN or GITHUB_TOKEN via env to auth with remote (0fe2d02)
• nx-ghpages: add support for writing CNAME file (3a098f0)
• nx-ghpages: add syncGitOptions to provide extra flags to the command when syncing changes (e015a98)

2.2.0 (2024-01-31)

Bug Fixes

• core: remove restriction of configuration (#823) (49b341f)
• dotnet: prevent "false" being incorrectly passed to dotnet command (#818) (0945571)

Features

• add options to sync the gh-pages branch with the base branch … (#815) (d9fff67)
• core: update inference configuration (#822) (6085c50)

2.1.2 (2023-11-29)

Bug Fixes

• core: do not use --verify-no-changes false for linting (#802) (9026fcf)

2.1.1 (2023-10-31)

Bug Fixes

• core: update localization files (#795) (7213b67)

2.1.0 (2023-10-25)

Bug Fixes

• core: should be able to pass extra args to generated libraries (#788) (2d2cb5b), closes #783

Features

• core: better configuration options for target inference (#787) (8a7b9a1)

2.0.2 (2023-10-24)

Bug Fixes

• core: options should be read correctly for project inference (#785) (0e5b73d)
• dotnet: correct flag passed to client to verify no changes (#786) (eab2d48)

2.0.1 (2023-10-20)

Bug Fixes

• core: createDependencies should work on windows (#782) (472fedc)

2.0.0 (2023-10-20)

Bug Fixes

• core: move generator not updating paths correctly (#767) (6398a06)

Features

• core: migrate to v16 and nx plugin API v2 (#763) (4451e8a)
• core: nx 17 support (#778) (33344cd)
• core: support allSourceTags (#768) and wildcards in check-module-boundaries.js (#771) (b55c597)

BREAKING CHANGES

• core: Drops Nx v15 support

1.23.0 (2023-09-20)

Bug Fixes

• core: add slash to use exact path (#685) (#687) (1a87d83)
• core: codegen should not import self and default to required reference types (#761) (2310556)
• core: obey path in solution-file parameter when generating projects (#762) (29c234d)
• core: support new name for enforce-module-boundaries eslint rule (#742) (24eb831)
• core: update-swagger executor always reinstalls tool (#757) (63cf4b4)
• dotnet: update args handling for dotnet format (#678) (772303e)

Features

• core: add argument forwarding to dotnet new (#722) (cdc3654)
• core: make swagger tool run in project directory (#758) (12d89ac)

1.22.0 (2023-04-12)

Bug Fixes

• core: import-projects should add project.json file for new projects (#675) (69068af)

Features

• core: add preset generator (#676) (57725ea)

1.21.1 (2023-03-22)

Bug Fixes

• core: use for of on loop on project Map (#661) (c9d31d7)

1.21.0 (2023-03-18)

Features

• core: extra parameters support for run tool (#658) (fe4bc14)

1.20.0 (2023-03-10)

Bug Fixes

• core: add @trumbitta/nx-plugin-openapi via the Tree (c2f2781)
• core: app generation should work in encapuslated Nx workspaces (13c0a2c)
• core: app swaggerLib generation should work using dotnet pathScheme (#645) (6443e32)
• core: check glob for array length (#647) (8033f76)
• core: handle null npm scope properly (455199a)
• core: prevent stale cache entries from breaking swagger on dotnet upgrades (#633) (71f6893)
• core: remove dependency on memfs and properly specify nx-plugin-openapi as optional peer dep (cf8f8c3)
• core: remove dependency on workspace package.json (d95a3ff)

Features

• core: nx 15.8.0 support (897e1a0)

1.19.1 (2023-02-04)

Bug Fixes

• core: adjust gitignore to support generation with directory (#599) (b3856e0)
• core: remove orphaned publish-local (#611) (7985e14)

1.19.0 (2023-02-01)

Bug Fixes

• core: install not ran after generating a webapi with useNxPluginOpenAPI (#601) (15e4db5)
• core: make eslint optional dependency (#608) (3705469)

Features

• core: add support for notDependOnLibsWithTags module boundaries (#592) (483086b)

1.18.1 (2023-01-26)

Bug Fixes

• core: build intermediates need to be captured by cache for DTE / parallel builds (#596) (cdea76e)
• core: resolve startupAssembly to ensure it is always an absolute path (#595) (2ea2570)

1.18.0 (2023-01-17)

Features

• core: support nx-plugin-openapi for more advanced openapi generation (#589) (ee1c7b1)

1.17.0 (2023-01-14)

Features

• core: add move generator (#588) (d2a1d85)
• core: enable codegen setup by default for webapis (#587) (fe639d7)

1.16.3 (2022-12-19)

Bug Fixes

• utils: should be able to find csproj files that start with dot (#580) (253971c)

1.16.2 (2022-11-11)

Bug Fixes

• core: check-module-boundaries should work if single quotes not consumed by shell (3870b55)
• core: normalize paths in Directory.Build.targets (e8bf1bc)

1.16.1 (2022-11-11)

Bug Fixes

• core: allow open solutions with Visual Studio (#563) (042a9db), closes #548
• core: usage of MSBuildProjectDirRelativePath should handle paths with white space (a939c4b)

1.16.0 (2022-11-03)

Bug Fixes

• core: check-module-boundaries should not log undefined as project name(#561) (5d1bea3)
• core: import-projects generator shouldn't fail (8c2188d)
• core: nx v15 prefers output paths that start with {workspaceRoot} (90b3aab)

Features

• core: allow disabling project inference from config file (2c8eeeb)

1.15.0 (2022-10-18)

Bug Fixes

• core: getProjectFilesForProject should consider project root in addition to source root (#543) (374e30f)

Features

• nx-ghpages: add option to customize commit message to gh-pages (#542) (cff00e0)

1.14.0 (2022-10-05)

Features

• core: adding templates with default output path properties to init generator (#526) (c57fbd3)

1.13.4 (2022-09-07)

Bug Fixes

• core: .sqlproj is a valid project extension (#523) (5d4f2d6)

1.13.3 (2022-09-06)

Bug Fixes

• core: add extraParameters support to build and test executors (#514) (c6c648d)

1.13.2 (2022-08-29)

Bug Fixes

• core: remove duplicate imports generated by swagger-typescript (#502) (0fc17d4)

1.13.1 (2022-08-19)

Bug Fixes

• core: @nrwl/js is required for library generation (#484) (13e2c93)
• core: use strict proj glob pattern (#495) (9720168)

1.13.0 (2022-07-29)

Bug Fixes

• core: skip-swagger-lib should be true while experimental (92cd2d8)

Features

• core: added pathScheme for project generators (#464) (ded5eb8)
• core: generate typescript models from swagger/openapi project (#447) (cd56d1c)

1.12.0 (2022-06-08)

Bug Fixes

• core: compatibility with Nx 14.2+ (1bb134b)

Features

• core: allow tool installation to be skipped for update-swagger (d1044f6)

1.11.0 (2022-05-31)

Features

• core: executor to generate swagger json (#437) (6c33d1a)

1.10.1 (2022-05-20)

Bug Fixes

• core: remove workaround for broken dotnet format builtin (#443) (e0f04eb)

1.10.0 (2022-05-18)

Features

• core: update prompt for installed template to present available options (#436) (5a941ae)

1.9.12 (2022-04-25)

Bug Fixes

• dotnet: dotnet watch --project ... test should work (#426) (1575dda), closes #425

1.9.11 (2022-04-21)

Bug Fixes

• core: replace glob with fast-glob to speed up dep-graph calculation (#414) (5db4ca9), closes #410
• dotnet: expand env vars in cli parameters (#422) (c2db0cd)

1.9.10 (2022-04-13)

Bug Fixes

• core: fall back to root if source root null (#408) (53bdc17)
• core: resolved package version not provided (#407) (9bbc7c1)
• core: test executor should fail properly (#411) (e2db293)

1.9.9 (2022-04-01)

Bug Fixes

• core: post-install shouldn't depend on nx packages (07811c7)

1.9.8 (2022-04-01)

Bug Fixes

• core: update nx to not publish *.ts files (3fa88c4)

1.9.7 (2022-03-25)

Bug Fixes

• core: allow opt-out of project inference (#402) (84bde4c)
• dotnet: update handling of extraParameters to be compatible with spawn (#403) (65f0c48)

1.9.6 (2022-03-10)

Bug Fixes

• core: add workaround for broken .NET format command in v6+ (#397) (2d09657)

1.9.5 (2022-03-03)

Bug Fixes

• dotnet: should work with paths that contain spaces (#392) (fa86355)

1.9.4 (2022-03-01)

Bug Fixes

• core: process project graph shouldn't throw if not a .NET project (#390) (4d51ea0)

1.9.3 (2022-03-01)

Bug Fixes

• core: infer-projects should work with nx daemon (#383) (acf47cf)

1.9.2 (2022-02-28)

Bug Fixes

• dotnet: project with spaces do not bug out the command (#379) (dd4e16b)

1.9.1 (2022-02-15)

Bug Fixes

• docs-site: fix deployment script (b3052a1)

1.9.0 (2022-02-15)

Bug Fixes

• core: dependencies should be added to graph when running under nx daemon

Features

• core: support for Nx project inference

1.8.0 (2021-12-14)

Bug Fixes

• core: add test projects to solution (9090b99)
• core: aliases were not being picked up when generating projects w/ solution files (56c770a)

Features

• core: support for nx incremental builds (6739a6b)

1.7.1 (2021-12-11)

Bug Fixes

• core: prebuild script fails if no module boundaries rule is present (bff34d0)

1.7.0 (2021-11-29)

Features

• core: support for workspace solution files (#254) (ec342ae)

1.6.0 (2021-10-22)

Features

• core: support nx v13 (#226) (3524ef9)

1.5.2 (2021-10-19)

Bug Fixes

• core: remove extra space in dotnet run --project (bf67bf3), closes #223

1.5.1 (2021-10-15)

Bug Fixes

• core: nx lint {project} should work when cwd !== appRootPath (#216) (9fac321), closes #215

1.5.0 (2021-10-15)

Features

• core: @nx-dotnet/core:serve can be ran with --watch false (#210) (9fd60e4), closes #151
• core: check for .net sdk install on package add (#212) (2ec5de9)
• core: project references with reference output assembly=false are implicit deps (#211) (34f87ee)

1.4.3 (2021-10-14)

Bug Fixes

• core: Check SDK and tool installation before running format command (#204) (3ad6291), closes #179 #202

1.4.2 (2021-09-27)

Bug Fixes

• use exact project paths (#143) (7a3c5e9), closes #125

1.4.1 (2021-09-15)

Bug Fixes

• core: npm prepare script may be removed (b8e88fa), closes #101
• core: publish output config should be relative to workspace root (30a7a26), closes #100

1.4.0 (2021-09-10)

Features

• core: ability to import projects into the nx configuration (8be8446)

1.3.2 (2021-08-26)

Bug Fixes

• core: serve + test --watch executor should not exit immediately (8484202), closes #96

1.3.1 (2021-08-24)

Bug Fixes

• use test project name in msbuild task (cc29ea9)

1.3.0 (2021-08-23)

Bug Fixes

• display project tag instead of [object Object] (2dea7fc)
• core: use fully qualified project name in msbuild task (2c54310)

Features

• core: pickup global.json overrides at the project level (49ce6bc), closes #87 #86

1.2.0 (2021-08-20)

Features

• core: #81 support for nx-enforce-module-boundaries (3fc92fd)
• core: ability to load module boundaries from nx-dotnet config (2618b5d)

1.1.4 (2021-08-13)

Bug Fixes

• update missing sections of misc. package.json files (dbcf9bd)

1.1.3 (2021-08-11)

Bug Fixes

• docs-site: prepush hook for docs changes (cfc92c1)

1.1.2 (2021-08-11)

Bug Fixes

• docs-site: docs changes should be committed back to repo (10e2936)

1.1.1 (2021-08-11)

Bug Fixes

• docs-site: docs changes should be committed back into repo (d773152)

1.1.0 (2021-08-10)

Features

• core: added support for test project name suffix (#78) (9f8f03c), closes #77

1.0.2 (2021-08-04)

Bug Fixes

• core: test project generator should add project reference correctly (b5bc27d)

1.0.1 (2021-08-04)

Bug Fixes

• core: dep-graph affected should work (#76) (2e56afc)

1.0.0 (2021-07-30)

Bug Fixes

• compatibility with nx 12.6+ (d393b3a)

BREAKING CHANGES

• Minimum Nx version is 12.6, if using the dep-graph plugin.

Co-authored-by: Leon Chi leon.chi@serko.com Co-authored-by: Craigory Coppola craigorycoppola@gmail.com

0.15.0 (2021-07-12)

Features

• core: Add generator option for standalone projects (#71) (8db11d4)

0.14.0 (2021-07-05)

Features

• core: add test project generator (#69) (7f7084f)

0.13.0 (2021-06-23)

Features

• nxdoc: support for docusaurus@2.0.0-beta.1 (3be3d48)

0.12.0 (2021-06-21)

Bug Fixes

• nx-ghpages: deploy executor should work (7d29f24)

Features

• nx-ghpages: initial work (621627d)

0.11.0 (2021-05-27)

Bug Fixes

• core: Remove extra separator from project names (#61) (049367c), closes #60

Features

• docs-site: support for docsearch (#62) [skip ci] (6d09f31)

0.10.3 (2021-05-24)

Bug Fixes

• nxdoc: nxdocs fails to run if any file does not have getting started text (f6b800f)
• nxdoc: template for oneOf includes extra bullet point (ce0687d)

0.10.2 (2021-05-24)

Bug Fixes

• nxdoc: anyOf is not officially supported by nx, but oneOf is (70f484f)

0.10.1 (2021-05-24)

Bug Fixes

• docs-site: correct docusaurus config (c479567)

0.10.0 (2021-05-23)

Bug Fixes

• docs-site: invalid baseUrl with custom domain (5cf6c70)
• nxdoc: include generator / executor description in detail file (b0bf601)

Features

• nx-docs: support for oneOf in schema.json files (7ab15c6)
• nxdoc: include getting started text (db3ec62)
• nxdoc: mark required properties (8b8b01c)

0.9.2 (2021-05-23)

Bug Fixes

• docs-site: invalid baseUrl with custom domain (5cf6c70)

0.9.1 (2021-05-23)

Bug Fixes

• docs-site: deploy on commit to master (e259a28)

0.9.0 (2021-05-23)

Features

• docs-site: setup docusaurus site (#57) (a268c70), closes #53

0.8.2 (2021-05-21)

Bug Fixes

• nxdoc: generators do not appear in index if no executors are present (c019467)

0.8.1 (2021-05-21)

Bug Fixes

• nxdoc: invalid generators.json (b3b03be)

0.8.0 (2021-05-21)

Features

• nxdoc: scaffold plugin + generate-docs v1 (80b0368)
• repo: docs generator prints options (bddc5b5)
• repo: schematic to generate docs #53 (a7828c5)

0.7.1 (2021-05-20)

Bug Fixes

• core: format files after successful migration (c92814a)
• core: rename migrations key to nx-migrations (c6993b9)
• repo: e2e tests run in CI again (f7ed139)

0.7.0 (2021-05-20)

Features

• core: add lint config to generated projects (d320ce8)
• core: add migration to add lint target (e391744)
• core: add new executor for dotnet-format (92afd05), closes #13

0.6.2 (2021-05-19)

Bug Fixes

• utils: forEachDependantProject should work on Unix (96cbc33), closes #43

0.6.1 (2021-05-19)

Bug Fixes

• core: add unused options parameter for restore (c8b0334)

0.6.0 (2021-05-19)

Bug Fixes

• core: add unused options parameter (c434d32)
• core: pass client through to init schematic (5908947)

Features

• core: add a generator for dotnet restore (96082a1)
• core: add restore to prepare script during init (c2b1c23), closes #44
• core: create tool manifest during init (996aaee), closes #44
• dotnet: add a method to install local tools (6ab5d4a), closes #44

0.5.2 (2021-05-18)

Bug Fixes

• core: dep-graph with various directory separators (3beccb4), closes #43

0.5.1 (2021-05-06)

Bug Fixes

• core: #38 - Misc fixes for .gitignore updates (#40) (5f2d5c9)
• core: sync command should list package names (#41) (8bdc66a), closes #39

0.5.0 (2021-05-06)

Features

• core: add executor for dotnet publish #33 (#36) (ac8c898)

0.4.2 (2021-05-05)

Bug Fixes

• core: #34 remove spec files from built plugin (f075046)
• core: #35 dry run is not passed to dotnet new (8e0b398)

0.4.1 (2021-05-03)

Bug Fixes

• core: test projects not generating (28d3d1e)

0.4.0 (2021-05-01)

Bug Fixes

• repo: update .releaserc to commit package.json version back (36d2f30)

Features

• core: schematic for adding npm package #5 (4f37be7), closes #6
• core: support for single version principle #6 (#32) (8e60a13)

0.3.0 (2021-04-28)

Bug Fixes

• core: #20 test template arg cannot be passed from command line (e9e47e0)
• repo: semantic-release not updating package.json (9273001)

Features

• core: dotnet test support #20 (02ceed0)

0.2.1 (2021-04-27)

Bug Fixes

• core: include serve target only for applications (#30) (d3a54ce), closes #28
• core: output paths still use windows separator on linux / mac (ed1c53a)
• core: use full project path in output directory (7748f9c), closes #27

Features

• repo: enable semantic-release (298c5af)

0.3.0-dev.2 (2021-04-27)

Bug Fixes

• core: include serve target only for applications (#30) (9e4438e), closes #28

0.3.0-dev.1 (2021-04-27)

Bug Fixes

• core: misc (7661829)
• core: output paths still use windows separator on linux / mac (b729fed)
• core: packages not published by last CI run (d07b9f3)
• core: use full project path in output directory (d9e5988), closes #27
• repo: deployment errors (0d92c44)

Features

• ci: fix publish script (4c6e91a)
• core: fix CD (9d5b787)
• core: fix deployments (561f462)
• core: semantic-release (799dc55)
• core: tag nx-dotnet projects (6442d94)
• core: test sr deployment (fbc5bbf)
• repo: enable semantic-release (12c223b)
• repo: semantic-release (895eb22)
• repo: update gh actions for semantic release (ed933e9)
• utils: update jsdocs (83bec44)

0.2.0 (2021-04-27)

Features

• core: test sr deployment (fbc5bbf)

0.2.0-dev.2 (2021-04-26)

Bug Fixes

• core: output paths still use windows separator on linux / mac (b729fed)
• core: packages not published by last CI run (d07b9f3)

Features

• ci: fix publish script (4c6e91a)
• core: tag nx-dotnet projects (6442d94)

0.2.0-dev.1 (2021-04-26)

Features

• core: Set output path in generated project files (96b48f8)
• repo: enable semantic-release (12c223b)
• repo: Update build script to utilize Nx's capabilities regarding package.json patching. (ee80435)
• repo: update gh actions for semantic release (ed933e9)