SatorImaging.DotnetTool.StaticImport 1.1.0

   ^{🇯🇵 日本語}

static-import is a dotnet cli tool to migrate file(s) from another project, github or public website.

In addition, there are features to modify C# script on migration. See C# Script Options for more details.

Installation

On the command line, enter the following command to install package as a command.

.NET SDK 8.0+ is required

dotnet tool install -g SatorImaging.DotnetTool.StaticImport

dnx Support

With .NET SDK 10.0 preview 6 or later, it can be run with dnx command like as follows, without installation.

dnx static-import --yes -- <OPTIONS>

Basic Usage

Here shows how to migrate files to current folder.

static-import -o "." -i \
    "local-file.cs" \
    "github:user@repo/BRANCH_TAG_OR_COMMIT/path/to/file.cs" \
    "https://gist.githubusercontent.com/..." \  # use raw url to download from gist
    "https://inter.net/path/to/file.cs"

Type static-import --help for more options.

For the use in GitHub Actions, see .github/workflows/tests.yml for details.

GitHub Options

static-import has dedicated scheme for GitHub files.

In contrast to https:, it retrieves correct Last-Modified value from repository.

github:<USER_NAME>@<REPO_NAME>/<REF>/path/to/file.ext

• REF: branch name, tag or commit hash

If the environment variable GH_TOKEN or GITHUB_TOKEN is defined, it is used for accesss to GitHub.

Here shows how to setup the variable in .yml file.

env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

See also: https://docs.github.com/actions/how-tos/security-for-github-actions/security-guides/automatic-token-authentication

C# Script Options

There are options to modify C# script on copying. (original file doesn't change)

• --internal
  • make declared type visibility to internal.
  • NOTE: doesn't affect on nested types.
• --namespace <NAME>
  • change namespace.
    • if name ending with ., it will be prepended (ex. Foo. --> Foo.Original.Namespace)
  • NOTE: nested namespace syntaxes leave untouched.

namespace FileScoped;  // 👈 changed

namespace Foo.Bar.Baz  // 👈 changed
{
    namespace Quuuuux  // untouched
    {
        public class MyClass  // 👈 changed
        {
            // untouched
            public enum MyEnum { }
            public struct MyStruct { }
            public record MyRecord { }
            public interface IMyInterface { }
        }
    }
}

License

MIT License