master v2.0
Aragas 4 years ago
parent f8e912d9a6
commit e388c154e6
No known key found for this signature in database
GPG Key ID: BE336CD7B5B763A7

357
.gitignore vendored

@ -0,0 +1,357 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# JustCode is a .NET coding add-in
.JustCode
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/
/src/docker-compose/cache_postgres/*
/src/docker-compose/cache_redis/*
/src/docker-compose/scraper_postgres/*
/src/docker-compose/subscriptions_postgres/*

4
.gitmodules vendored

@ -0,0 +1,4 @@
[submodule "build/DocFx.Plugin.LastModified"]
path = build/DocFx.Plugin.LastModified
url = https://github.com/Still34/DocFx.Plugin.LastModified.git
branch = master

@ -12,10 +12,6 @@ inputs:
newtonsoftjson-version:
description: ''
default: '11.0.2'
sandcastlexrefgenerator-directory:
description: ''
default: './build/SandcastleXrefGenerator'
runs:
using: "composite"
@ -56,14 +52,13 @@ runs:
- name: Generating Newtonsoft.Json xref maps
run: >-
if (-Not (Test-Path -Path '${{inputs.sandcastlexrefgenerator-directory}}')) { Return };
dotnet run -p ${{inputs.sandcastlexrefgenerator-directory}} -- `
dotnet run --project ${{ github.action_path }}/build/SandcastleXrefGenerator -- `
Newtonsoft.Json ${{inputs.newtonsoftjson-version}} netstandard2.0 `
https://www.newtonsoft.com/json/help/html/ `
${{inputs.docs-directory}}/xrefs/Newtonsoft.Json-xrefmap.yml
shell: pwsh
#- name: DocFx.Plugin.LastModified
# run: >-
# dotnet build build/DocFx.Plugin.LastModified/DocFx.Plugin.LastModified --configuration Release --output docs/_template/last-modified/plugins;
# shell: pwsh
- name: Build DocFx.Plugin.LastModified
run: >-
dotnet build --project ${{ github.action_path }}/build/DocFx.Plugin.LastModified/DocFx.Plugin.LastModified --configuration Release --output ${{inputs.docs-directory}}/_template/last-modified/plugins;
shell: pwsh

@ -0,0 +1 @@
Subproject commit 073ba660e88509980835219ae92c17a0da8c2bb7

@ -0,0 +1,92 @@
// Copyright 2019 The Noda Time Authors. All rights reserved.
// Use of this source code is governed by the Apache License 2.0,
// as found in the LICENSE.txt file.
using Microsoft.DocAsCode.Build.Engine;
using Microsoft.DocAsCode.Plugins;
using Mono.Cecil;
using SharpCompress.Archives.Zip;
using System;
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Threading.Tasks;
using YamlDotNet.Serialization;
namespace SandcastleXrefGenerator
{
public static class Program
{
public static async Task<int> Main(string[] args)
{
if (args.Length != 5)
{
Console.WriteLine("Usage: <nuget package> <version> <tfm> <baseUrl> <outputFile>");
return 1;
}
var packageStream = await DownloadPackage(args[0], args[1]);
var module = LoadModule(packageStream, args[2]);
var map = BuildXRefMap(module, args[3]);
var serializer = new SerializerBuilder().Build();
var file = new FileInfo(args[4]);
file.Directory!.Create();
serializer.Serialize(file.CreateText(), map);
return 0;
}
private static async Task<Stream> DownloadPackage(string package, string version)
{
var client = new HttpClient();
var bytes = await client.GetByteArrayAsync($"https://www.nuget.org/api/v2/package/{package}/{version}");
return new MemoryStream(bytes);
}
private static ModuleDefinition LoadModule(Stream package, string tfm)
{
var prefix = $"lib/{tfm}";
using var zip = ZipArchive.Open(package);
foreach (var entry in zip.Entries)
{
// We assume there's just one assembly, for simplicity.
if (entry.Key.StartsWith(prefix) && entry.Key.EndsWith(".dll"))
{
using var stream = entry.OpenEntryStream();
// Mono.Cecil requires the stream to be seekable. It's simplest
// just to copy the whole DLL to a MemoryStream and pass that to Cecil.
var ms = new MemoryStream();
stream.CopyTo(ms);
ms.Position = 0;
return ModuleDefinition.ReadModule(ms);
}
}
throw new Exception($"No file found in package starting with '{prefix}'");
}
private static XRefMap BuildXRefMap(ModuleDefinition module, string baseUrl) => new XRefMap
{
BaseUrl = baseUrl,
References = module.Types
.Select(CreateXRefSpec)
.Where(spec => spec != null)
.ToList()
};
private static XRefSpec CreateXRefSpec(TypeDefinition type)
{
if (!type.IsPublic)
{
return null;
}
return new XRefSpec
{
Name = type.Name, // TODO: Get the name with <T> etc in
Uid = type.FullName, // Is this really enough?
Href = $"T_{type.FullName.Replace('.', '_').Replace('`', '_')}.htm",
CommentId = $"T:{type.FullName}"
};
}
}
}

@ -0,0 +1,24 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net472</TargetFramework>
<langversion>8.0</langversion>
</PropertyGroup>
<ItemGroup>
<!-- It's this dependency that forces us to use the full framework. Replace when we can... -->
<PackageReference Include="Microsoft.DocAsCode.Build.Engine" Version="2.41.0" />
<PackageReference Include="Mono.Cecil" Version="0.10.0-beta5" />
<PackageReference Include="MoreLinq" Version="2.3.0" />
<PackageReference Include="SharpCompress" Version="0.29.0" />
<PackageReference Include="YamlDotNet" Version="6.0.0" />
<Reference Include="System.Net.Http" />
<!-- Make sure we can build on non-Windows, even though we can't run. -->
<PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies"
Version="1.0.0-preview.1"
PrivateAssets="All" />
</ItemGroup>
</Project>
Loading…
Cancel
Save