Skip to content

Make build.psd1 optional and fix bugs in 1.5.2 #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Jaykul merged 17 commits into from
Feb 10, 2020
Merged

Make build.psd1 optional and fix bugs in 1.5.2 #89

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
4e2a651
Update tests so they work better in VSCode
Jaykul Dec 19, 2019
9c08545
Whitespace cleanup commit
Jaykul Jan 11, 2020
84658d2
Fix #87 by switching "ModuleManifest" to "SourcePath"
Jaykul Jan 11, 2020
3dc7800
Update documentation about required changes to module manifests
Jaykul Jan 11, 2020
7d519fa
Finally make the build.psd1 file optional per #44
Jaykul Jan 11, 2020
d28c47d
Add tests to verify prefix works right
Jaykul Jan 11, 2020
cb936ce
Fix #88 by keeping the prefix from build.psd1
Jaykul Jan 11, 2020
e6a894c
Fix build by working around the bug in 1.5.2
Jaykul Jan 11, 2020
4564df7
Fix a few tests that will break if we check module manifests better
Jaykul Jan 14, 2020
0d78ae5
Fix ResolveBuildManifest Tests (it no longer throws) in this branch
Jaykul Jan 14, 2020
59dd957
Add ImportModuleManifest to wrap Get-Module
Jaykul Jan 14, 2020
d873623
Switch to searching for module manifests
Jaykul Jan 14, 2020
55ce9c8
Update to fixed azure-pipeline
Jaykul Jan 14, 2020
12d5fd9
Clean up capitalization
Jaykul Jan 15, 2020
c128593
Fix integration test and test.ps1
Jaykul Jan 15, 2020
2aa4c4f
Clean up debug output
Jaykul Jan 15, 2020
0a8a42f
Fix the normalization / guessing of SourcePath
Jaykul Jan 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update documentation about required changes to module manifests
  • Loading branch information
@Jaykul
Jaykul committed Jan 11, 2020
commit 3dc7800c9ec7c3fb7faa7972df93b4c1516e1b06
7 changes: 5 additions & 2 deletions ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,15 @@ For best results, you need to organize your module project similarly to how this

1. Create a `source` folder with a `build.psd1` file and your module manifest in it
2. In the `build.psd1` specify the relative **Path** to your module's manifest, e.g. `@{ Path = "ModuleBuilder.psd1" }`
3. In your manifest, make sure the `FunctionsToExport` entry is not commented out. You can leave it empty
3. In your manifest, make sure a few values are not commented out. You can leave them empty, because they'll be overwritten:
- `FunctionsToExport` will be updated with the _file names_ that match the `PublicFilter`
- `AliasesToExport` will be updated with the values from `[Alias()]` attributes on commands
- `Prerelease` and `ReleaseNotes` in the `PSData` hashtable in `PrivateData`

Once you start working on the module, you'll create sub-folders in source, and put script files in them with only **one** function in each file. You should name the files with _the same name_ as the function that's in them -- especially in the public folder, where we use the file name (without the extension) to determine the exported functions.

1. By convention, use folders named "Classes" (and/or "Enum"), "Private", and "Public"
2. By convention, the functions in "Public" will be exported from the module
2. By convention, the functions in "Public" will be exported from the module (you can override the `PublicFilter`)
3. To force classes to be in a certain order, you can prefix their file names with numbers, like `01-User.ps1`

There are a *lot* of conventions in `Build-Module`, expressed as default values for its parameters. These defaults are documented in the help for Build-Module. You can override any parameter to `Build-Module` by passing it, or by adding keys to the `build.psd1` file with your preferences.