Merge pull request #74 from kzrnm/feature/v4

v4.0.0
kzrnm · Jan 22, 2022 · 0f2e6c3 · 0f2e6c3
2 parents f6b6e0d + 7a34270
commit 0f2e6c3
Show file tree

Hide file tree

Showing 7 changed files with 66 additions and 21 deletions.
diff --git a/.github/workflows/generate-toc.yml b/.github/workflows/generate-toc.yml
@@ -1,5 +1,7 @@
-on: 
+on:
   push:
+    paths:
+      - "**.md"
     branches-ignore:
       - "master"
 name: TOC Generator
@@ -10,4 +12,4 @@ jobs:
     steps:
       - uses: technote-space/toc-generator@v3
         with:
-          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.ACCESS_TOKEN }}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [4.0.0] - Unreleased
+## [4.0.0] - 2022-01-22
 ### Added
 - Source Generator V2: Incremental Generetor
 - SourceExpander.Console

diff --git a/Directory.Build.props b/Directory.Build.props
@@ -8,8 +8,8 @@
 		<PackageProjectUrl>https://github.com/kzrnm/SourceExpander</PackageProjectUrl>
 		<RepositoryUrl>https://github.com/kzrnm/SourceExpander</RepositoryUrl>
 		<PackageReleaseNotes>https://github.com/kzrnm/SourceExpander/blob/master/CHANGELOG.md</PackageReleaseNotes>
-		<Version>4.0.0-beta4</Version>
-		<AssemblyVersion>4.0.0.4</AssemblyVersion>
+		<Version>4.0.0</Version>
+		<AssemblyVersion>4.0.0.100</AssemblyVersion>
 		<SignAssembly>True</SignAssembly>
 		<AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)key.snk</AssemblyOriginatorKeyFile>
 		<PackageOutputPath>$(MSBuildThisFileDirectory)bin\Packages\$(Configuration)\</PackageOutputPath>

diff --git a/README.ja.md b/README.ja.md
@@ -10,11 +10,14 @@ README languages:
 
 - [Packages](#packages)
   - [SourceExpander(library)](#sourceexpanderlibrary)
+  - [SourceExpander.Console](#sourceexpanderconsole)
   - [SourceExpander.Generator](#sourceexpandergenerator)
   - [SourceExpander.Embedder](#sourceexpanderembedder)
 - [Status](#status)
 - [Getting started](#getting-started)
   - [ライブラリ利用者向け](#%E3%83%A9%E3%82%A4%E3%83%96%E3%83%A9%E3%83%AA%E5%88%A9%E7%94%A8%E8%80%85%E5%90%91%E3%81%91)
+    - [SourceExpander.Console を使う](#sourceexpanderconsole-%E3%82%92%E4%BD%BF%E3%81%86)
+    - [SourceExpander.Generator を使う](#sourceexpandergenerator-%E3%82%92%E4%BD%BF%E3%81%86)
   - [ライブラリ開発者向け](#%E3%83%A9%E3%82%A4%E3%83%96%E3%83%A9%E3%83%AA%E9%96%8B%E7%99%BA%E8%80%85%E5%90%91%E3%81%91)
     - [埋め込みたくない型への対処](#%E5%9F%8B%E3%82%81%E8%BE%BC%E3%81%BF%E3%81%9F%E3%81%8F%E3%81%AA%E3%81%84%E5%9E%8B%E3%81%B8%E3%81%AE%E5%AF%BE%E5%87%A6)
   - [注釈](#%E6%B3%A8%E9%87%88)
@@ -33,12 +36,14 @@ README languages:
 
 ソースコードをファイルに展開するライブラリです。
 
+### SourceExpander.Console
+
+ソースジェネレーターで埋め込まれたソースコードを展開するコンソールアプリです。
 
 ### SourceExpander.Generator
 
 ソースジェネレーターで埋め込まれたソースコードを展開するライブラリです。
 
-
 ### SourceExpander.Embedder
 
 ソースコードを埋め込むライブラリです。
@@ -60,6 +65,24 @@ README languages:
 
 ### ライブラリ利用者向け
 
+#### SourceExpander.Console を使う
+
+Install:
+```sh
+dotnet tool install -g SourceExpander.Console
+```
+
+Run:
+```sh
+# minimum run
+dotnet-source-expand Sample/SampleProject2/Program.cs
+
+# specified project
+dotnet-source-expand Sample/SampleProject/Put.cs -p Sample/SampleProject2/SampleProject2.csproj
+```
+
+#### SourceExpander.Generator を使う
+
 [Sample](/Sample) や https://github.com/naminodarie/ac-library-csharp を参考としてください。
 
 ```

diff --git a/README.md b/README.md
@@ -10,11 +10,14 @@ README languages:
 
 - [Packages](#packages)
   - [SourceExpander(library)](#sourceexpanderlibrary)
+  - [SourceExpander.Console](#sourceexpanderconsole)
   - [SourceExpander.Generator](#sourceexpandergenerator)
   - [SourceExpander.Embedder](#sourceexpanderembedder)
 - [Status](#status)
 - [Getting started](#getting-started)
   - [For library user](#for-library-user)
+    - [Use SourceExpander.Console](#use-sourceexpanderconsole)
+    - [Use SourceExpander.Generator](#use-sourceexpandergenerator)
   - [For library developer](#for-library-developer)
     - [Avoid embedding some type](#avoid-embedding-some-type)
   - [Notes](#notes)
@@ -33,6 +36,9 @@ README languages:
 
 Library that expand embedded source codes.
 
+### SourceExpander.Console
+
+Console application that expand embedded source codes.
 
 ### SourceExpander.Generator
 
@@ -60,6 +66,24 @@ This library require **.NET 5 SDK** or **Visual Studio 16.8** or later because t
 
 ### For library user
 
+#### Use SourceExpander.Console
+
+Install:
+```sh
+dotnet tool install -g SourceExpander.Console
+```
+
+Run:
+```sh
+# minimum run
+dotnet-source-expand Sample/SampleProject2/Program.cs
+
+# specified project
+dotnet-source-expand Sample/SampleProject/Put.cs -p Sample/SampleProject2/SampleProject2.csproj
+```
+
+#### Use SourceExpander.Generator
+
 see [Sample](/Sample) or https://github.com/kzrnm/ac-library-csharp
 
 ```

diff --git a/Sample/SampleProject2/Put.cs b/Sample/SampleProject2/Put.cs
diff --git a/Sample/SampleProject2/SampleProject2.csproj b/Sample/SampleProject2/SampleProject2.csproj
@@ -1,13 +1,15 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
-  <PropertyGroup>
-    <OutputType>Exe</OutputType>
-    <TargetFramework>netcoreapp3.1</TargetFramework>
-  </PropertyGroup>
-
-  <ItemGroup>
-    <ProjectReference Include="..\_SampleLibrary\_SampleLibrary.csproj" />
-    <ProjectReference Include="..\_SampleLibrary2\_SampleLibrary2.csproj" />
-  </ItemGroup>
+	<PropertyGroup>
+		<OutputType>Exe</OutputType>
+		<TargetFramework>netcoreapp3.1</TargetFramework>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<ProjectReference Include="..\_SampleLibrary\_SampleLibrary.csproj" />
+		<ProjectReference Include="..\_SampleLibrary2\_SampleLibrary2.csproj" />
+
+		<Compile Include="../SampleProject/Put.cs" />
+	</ItemGroup>
 
 </Project>