Help_Files/New-NodeModule-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-NodeModule</command:name> <command:verb>New</command:verb> <command:noun>NodeModule</command:noun> <maml:description> <maml:para>Creates a new Node.js module using some preferred default values.</maml:para> </maml:description> </command:details> <maml:description> <maml:para> Creates a new Node module using some default values that I prefer in each of my projects. Such as license type, the license file itself, etc. Returns true or false if the module was created without problem. If false is returned, there should also be some more information regarding why it failed.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-NodeModule</maml:name> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ModuleName</maml:name> <maml:Description> <maml:para>The name of the new module you wish to create.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>ModulePath</maml:name> <maml:Description> <maml:para>The path of where you would like the module to be created. If none is provided, D:\Development\Projects\NodeJS_Packages is used.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="none"> <maml:name>OpenInVSCode</maml:name> <maml:Description> <maml:para>A switch parameter indicating if you'd like to open the newly created module in Visual Studio Code. Defaults to $true.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false"></command:parameterValue> <dev:type> <maml:name></maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes /> <command:returnValues /> <maml:alertSet> <maml:alert> <maml:para>The easiest way to add this to your profile is to copy this file to your WindowsPowerShell profile path ($ENV:HOMEPATH\Documents\WindowsPowerShell) and then add the following line somewhere in your Profile.ps1 file (if you're unsure what this is, see http://bit.ly/poshprofiles):</maml:para> <maml:para>. $ENV:HOMEDRIVE\$ENV:HOMEPATH\Documents\WindowsPowerShell\New-NodeModule.ps1</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>--------------------- Create Test Module 1 ---------------------</maml:title> <dev:code>PS C:\> New-NodeModule -ModuleName 'Test Module 1' -ModulePath C:\Temp</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>------------------ Custom Location w/out Code ------------------</maml:title> <dev:code>PS C:\> New-NodeModule outside-cli C:\Dev\node_packages $false</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------- New Module w/out Code --------------------</maml:title> <dev:code>PS C:\> New-NodeModule temp-cli-test -Open $False</dev:code> <dev:remarks> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |