Skip to content
This repository was archived by the owner on Jan 19, 2021. It is now read-only.

Commit 41a0681

Browse files
committed
Merge pull request #15 from OfficeDev/dev
Extra August Master Merge
2 parents cc492a8 + 4618362 commit 41a0681

File tree

372 files changed

+16788
-4
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

372 files changed

+16788
-4
lines changed

.gitignore

+212
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,212 @@
1+
## Ignore Visual Studio temporary files, build results, and
2+
## files generated by popular Visual Studio add-ons.
3+
4+
# User-specific files
5+
*.suo
6+
*.user
7+
*.userosscache
8+
*.sln.docstates
9+
10+
# User-specific files (MonoDevelop/Xamarin Studio)
11+
*.userprefs
12+
13+
# Build results
14+
[Dd]ebug/
15+
[Dd]ebugPublic/
16+
[Rr]elease/
17+
[Rr]eleases/
18+
x64/
19+
x86/
20+
build/
21+
bld/
22+
[Bb]in/
23+
[Oo]bj/
24+
25+
# Visual Studio 2015 cache/options directory
26+
.vs/
27+
28+
# MSTest test Results
29+
[Tt]est[Rr]esult*/
30+
[Bb]uild[Ll]og.*
31+
32+
# NUNIT
33+
*.VisualState.xml
34+
TestResult.xml
35+
36+
# Build Results of an ATL Project
37+
[Dd]ebugPS/
38+
[Rr]eleasePS/
39+
dlldata.c
40+
41+
# DNX
42+
project.lock.json
43+
artifacts/
44+
45+
*_i.c
46+
*_p.c
47+
*_i.h
48+
*.ilk
49+
*.meta
50+
*.obj
51+
*.pch
52+
*.pdb
53+
*.pgc
54+
*.pgd
55+
*.rsp
56+
*.sbr
57+
*.tlb
58+
*.tli
59+
*.tlh
60+
*.tmp
61+
*.tmp_proj
62+
*.log
63+
*.vspscc
64+
*.vssscc
65+
.builds
66+
*.pidb
67+
*.svclog
68+
*.scc
69+
70+
# Chutzpah Test files
71+
_Chutzpah*
72+
73+
# Visual C++ cache files
74+
ipch/
75+
*.aps
76+
*.ncb
77+
*.opensdf
78+
*.sdf
79+
*.cachefile
80+
81+
# Visual Studio profiler
82+
*.psess
83+
*.vsp
84+
*.vspx
85+
86+
# TFS 2012 Local Workspace
87+
$tf/
88+
89+
# Guidance Automation Toolkit
90+
*.gpState
91+
92+
# ReSharper is a .NET coding add-in
93+
_ReSharper*/
94+
*.[Rr]e[Ss]harper
95+
*.DotSettings.user
96+
97+
# JustCode is a .NET coding add-in
98+
.JustCode
99+
100+
# TeamCity is a build add-in
101+
_TeamCity*
102+
103+
# DotCover is a Code Coverage Tool
104+
*.dotCover
105+
106+
# NCrunch
107+
_NCrunch_*
108+
.*crunch*.local.xml
109+
110+
# MightyMoose
111+
*.mm.*
112+
AutoTest.Net/
113+
114+
# Web workbench (sass)
115+
.sass-cache/
116+
117+
# Installshield output folder
118+
[Ee]xpress/
119+
120+
# DocProject is a documentation generator add-in
121+
DocProject/buildhelp/
122+
DocProject/Help/*.HxT
123+
DocProject/Help/*.HxC
124+
DocProject/Help/*.hhc
125+
DocProject/Help/*.hhk
126+
DocProject/Help/*.hhp
127+
DocProject/Help/Html2
128+
DocProject/Help/html
129+
130+
# Click-Once directory
131+
publish/
132+
133+
# Publish Web Output
134+
*.[Pp]ublish.xml
135+
*.azurePubxml
136+
## TODO: Comment the next line if you want to checkin your
137+
## web deploy settings but do note that will include unencrypted
138+
## passwords
139+
#*.pubxml
140+
141+
*.publishproj
142+
143+
# NuGet Packages
144+
*.nupkg
145+
# The packages folder can be ignored because of Package Restore
146+
**/packages/*
147+
# except build/, which is used as an MSBuild target.
148+
!**/packages/build/
149+
# Uncomment if necessary however generally it will be regenerated when needed
150+
#!**/packages/repositories.config
151+
152+
# Windows Azure Build Output
153+
csx/
154+
*.build.csdef
155+
156+
# Windows Store app package directory
157+
AppPackages/
158+
159+
# Visual Studio cache files
160+
# files ending in .cache can be ignored
161+
*.[Cc]ache
162+
# but keep track of directories ending in .cache
163+
!*.[Cc]ache/
164+
165+
# Others
166+
ClientBin/
167+
[Ss]tyle[Cc]op.*
168+
~$*
169+
*~
170+
*.dbmdl
171+
*.dbproj.schemaview
172+
*.pfx
173+
*.publishsettings
174+
node_modules/
175+
orleans.codegen.cs
176+
177+
# RIA/Silverlight projects
178+
Generated_Code/
179+
180+
# Backup & report files from converting an old project file
181+
# to a newer Visual Studio version. Backup files are not needed,
182+
# because we have git ;-)
183+
_UpgradeReport_Files/
184+
Backup*/
185+
UpgradeLog*.XML
186+
UpgradeLog*.htm
187+
188+
# SQL Server files
189+
*.mdf
190+
*.ldf
191+
192+
# Business Intelligence projects
193+
*.rdl.data
194+
*.bim.layout
195+
*.bim_*.settings
196+
197+
# Microsoft Fakes
198+
FakesAssemblies/
199+
200+
# Node.js Tools for Visual Studio
201+
.ntvs_analysis.dat
202+
203+
# Visual Studio 6 build log
204+
*.plg
205+
206+
# Visual Studio 6 workspace options file
207+
*.opt
208+
209+
# LightSwitch generated files
210+
GeneratedArtifacts/
211+
_Pvt_Extensions/
212+
ModelManifest.xml

Binaries/PnPPowerShellCommands15.msi

2.61 MB
Binary file not shown.

Binaries/PnPPowerShellCommands16.msi

2.68 MB
Binary file not shown.

CONTRIBUTING.md

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Contribution guidance
2+
3+
4+
5+
*work in progress*
6+
7+
8+
9+
All PnP repositories are following up on the standard PnP process on getting started and contribute.
10+
11+
12+
See following PnP wiki page from the main repository for additional details.
13+
14+
15+
16+
- For getting started guidance, see [Setting up your environment](https://github.com/OfficeDev/PnP/wiki/Setting-up-your-environment).
17+
18+
19+
20+
*Notice that you'll need to update the URLs based on used repository. All community contributions are also more than welcome.
21+
Please see following page for additional insights on the model.
22+
23+
24+
25+
- For contributing to PnP, see [Contributing to Office 365 developer patterns and practices](https://github.com/OfficeDev/PnP/wiki/contributing-to-Office-365-developer-patterns-and-practices)
26+
27+
28+
29+
---
30+
31+
32+
##Documentation contributions
33+
If you want to contribute to cmdlet documentation, please do not make a pull request to modify the actual files in the Documentation folder itself. Those files
34+
are automatically generated based upon comments in the actual classes. So if you want to modify documentation and or add an example of a cmdlet, navigate to the
35+
corresponding class where the cmdlet is being implemented and add the comments there. An example can for instance be found in
36+
37+
https://github.com/OfficeDev/PnP-PowerShell/blob/dev/Commands/Fields/AddField.cs
38+
39+
Notice the [CmdletHelp("")] and [CmdletExample()] class attributes that describe the cmdlet.
40+
41+
##Cmdlet contributions
42+
43+
A few notes:
44+
* Every new cmdlet should provide help and examples.
45+
* Most cmdlets will extend SPOWebCmdlet which provides a few helper objects for you to use.
46+
* Cmdlets will have to work both on-premises and in the cloud. You can use preprocessor variables ("CLIENTSDKV15" and "CLIENTSDKV16") to build different cmdlets for the different targets.
47+
* The verb of a cmdlet (get-, add-, etc.) should follow acceptable cmdlet standards and should be part of one of the built in verbs classes (VerbsCommon, VerbsData, etc.)
48+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
3+
<metadata>
4+
<id>OfficeDevPnPPowershellCommands15</id>
5+
<version>1.3.0.0</version>
6+
<title>OfficeDev PnP PowerShell Cmdlets for SharePoint On-Premises</title>
7+
<authors>Erwin van Hunen</authors>
8+
<licenseUrl>https://github.com/OfficeDev/PnP/blob/master/README.md</licenseUrl>
9+
<requireLicenseAcceptance>true</requireLicenseAcceptance>
10+
<description>Office Dev PnP PowerShell Cmdlets for SharePoint On-Premises. Includes the latest client side assemblies.</description>
11+
</metadata>
12+
</package>
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
$name = "officedevpnppowershellcommands15"
2+
$url = "https://github.com/OfficeDev/PnP-PowerShell/releases/download/v1.2/PnPPowerShellCommands15.msi"
3+
Install-ChocolateyPackage $name 'msi' '/quiet' $url
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
$name = "officedevpnppowershellcommands15"
2+
Uninstall-ChocolateyPackage $name 'msi' "https://github.com/OfficeDev/PnP-PowerShell/releases/download/v1.2/PnPPowerShellCommands15.msi /qn"
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<package xmlns="http://schemas.microsoft.com/packaging/2010/07/nuspec.xsd">
3+
<metadata>
4+
<id>OfficeDevPnPPowershellCommands16</id>
5+
<version>1.3.0.0</version>
6+
<title>OfficeDev PnP PowerShell Cmdlets for Office 365</title>
7+
<authors>Erwin van Hunen</authors>
8+
<licenseUrl>https://github.com/OfficeDev/PnP/blob/master/README.md</licenseUrl>
9+
<requireLicenseAcceptance>true</requireLicenseAcceptance>
10+
<description>Office Dev PnP PowerShell Cmdlets for Office 365. Includes the latest client side assemblies.</description>
11+
</metadata>
12+
</package>
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
$name = "officedevpnppowershellcommands16"
2+
$url = "https://github.com/OfficeDev/PnP-PowerShell/releases/download/v1.2/PnPPowerShellCommands16.msi"
3+
Install-ChocolateyPackage $name 'msi' '/quiet' $url
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
$name = "officedevpnppowershellcommands16"
2+
Uninstall-ChocolateyPackage $name 'msi' "https://github.com/OfficeDev/PnP-PowerShell/releases/download/v1.2/PnPPowerShellCommands16.msi /qn"

CmdletHelpGenerator/App.config

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<?xml version="1.0" encoding="utf-8" ?>
2+
<configuration>
3+
<startup>
4+
<supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
5+
</startup>
6+
</configuration>

CmdletHelpGenerator/CmdletInfo.cs

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Text;
5+
using System.Threading.Tasks;
6+
7+
namespace OfficeDevPnP.PowerShell.CmdletHelpGenerator
8+
{
9+
public class CmdletInfo
10+
{
11+
public string Verb { get; set; }
12+
public string Noun { get; set; }
13+
14+
public string Description { get; set; }
15+
16+
public string DetailedDescription { get; set; }
17+
18+
public List<CmdletParameterInfo> Parameters { get; set; }
19+
20+
public string Version { get; set; }
21+
22+
public string Copyright { get; set; }
23+
24+
public List<CmdletSyntax> Syntaxes { get; set; }
25+
26+
public string FullCommand
27+
{
28+
get
29+
{
30+
return string.Format("{0}-{1}", Verb, Noun);
31+
}
32+
}
33+
34+
public string Category { get; set; }
35+
36+
public CmdletInfo(string verb, string noun)
37+
{
38+
Verb = verb;
39+
Noun = noun;
40+
Parameters = new List<CmdletParameterInfo>();
41+
Syntaxes = new List<CmdletSyntax>();
42+
}
43+
}
44+
}
+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
using System;
2+
using System.Collections.Generic;
3+
using System.Linq;
4+
using System.Text;
5+
using System.Threading.Tasks;
6+
7+
namespace OfficeDevPnP.PowerShell.CmdletHelpGenerator
8+
{
9+
public class CmdletParameterInfo
10+
{
11+
public string Name { get; set; }
12+
public string Type { get; set; }
13+
public string Description { get; set; }
14+
15+
public bool Required { get; set; }
16+
17+
public string ParameterSetName { get; set; }
18+
19+
public int Position { get; set; }
20+
}
21+
}

0 commit comments

Comments
 (0)