en/90_Dotnet.ipynb

{"cells": [{"cell_type": "markdown", "metadata": {}, "source": ["## Welcome to .NET"]}, {"attachments": {}, "cell_type": "markdown", "metadata": {}, "source": ["The `dotnet` command is the one that allows the handling of the codes in .NET. Although the same command is used, it has a _runtime_ variant that allows you to run programs, and a development variant, which is used to create, organize, test, and compile code.\n", "\n", "\n", "```bash\n", "dotnet --help\n", "```\n", "gives information about the command and its variants:\n", "\n", "```bash\n", "Usage: dotnet [runtime-options] [path-to-application] [arguments]\n", "\n", "Execute a .NET application.\n", "\n", "runtime-options:\n", "  --additionalprobingpath <path>   Path containing probing policy and assemblies to probe for.\n", "  --additional-deps <path>         Path to additional deps.json file.\n", "  --depsfile                       Path to <application>.deps.json file.\n", "  --fx-version <version>           Version of the installed Shared Framework to use to run the application.\n", "  --roll-forward <setting>         Roll forward to framework version  (LatestPatch, Minor, LatestMinor, Major, LatestMajor, Disable).\n", "  --runtimeconfig                  Path to <application>.runtimeconfig.json file.\n", "\n", "path-to-application:\n", "  The path to an application .dll file to execute.\n", "\n", "Usage: dotnet [sdk-options] [command] [command-options] [arguments]\n", "\n", "Execute a .NET SDK command.\n", "\n", "sdk-options:\n", "  -d|--diagnostics  Enable diagnostic output.\n", "  -h|--help         Show command line help.\n", "  --info            Display .NET information.\n", "  --list-runtimes   Display the installed runtimes.\n", "  --list-sdks       Display the installed SDKs.\n", "  --version         Display .NET SDK version in use.\n", "\n", "SDK commands:\n", "  add               Add a package or reference to a .NET project.\n", "  build             Build a .NET project.\n", "  build-server      Interact with servers started by a build.\n", "  clean             Clean build outputs of a .NET project.\n", "  format            Apply style preferences to a project or solution.\n", "  help              Show command line help.\n", "  list              List project references of a .NET project.\n", "  msbuild           Run Microsoft Build Engine (MSBuild) commands.\n", "  new               Create a new .NET project or file.\n", "  nuget             Provides additional NuGet commands.\n", "  pack              Create a NuGet package.\n", "  publish           Publish a .NET project for deployment.\n", "  remove            Remove a package or reference from a .NET project.\n", "  restore           Restore dependencies specified in a .NET project.\n", "  run               Build and run a .NET project output.\n", "  sdk               Manage .NET SDK installation.\n", "  sln               Modify Visual Studio solution files.\n", "  store             Store the specified assemblies in the runtime package store.\n", "  test              Run unit tests using the test runner specified in a .NET project.\n", "  tool              Install or manage tools that extend the .NET experience.\n", "  vstest            Run Microsoft Test Engine (VSTest) commands.\n", "  workload          Manage optional workloads.\n", "\n", "Additional commands from bundled tools:\n", "  dev-certs         Create and manage development certificates.\n", "  fsi               Start F# Interactive / execute F# scripts.\n", "  user-jwts         Manage JSON Web Tokens in development.\n", "  user-secrets      Manage development user secrets.\n", "  watch             Start a file watcher that runs a command when files change.\n", "```"]}, {"attachments": {}, "cell_type": "markdown", "metadata": {}, "source": ["\n", "```bash\n", "dotnet --info\n", "```\n", "shows the information of installed _runtime_ and _sdks_:\n", "\n", "```bash\n", ".NET SDK:\n", " Version:   7.0.102\n", " Commit:    4bbdd14480\n", "\n", "Runtime Environment:\n", " OS Name:     Mac OS X\n", " OS Version:  12.6\n", " OS Platform: Darwin\n", " RID:         osx.12-x64\n", " Base Path:   /usr/local/share/dotnet/sdk/7.0.102/\n", "\n", "Host:\n", "  Version:      7.0.2\n", "  Architecture: x64\n", "  Commit:       d037e070eb\n", "\n", ".NET SDKs installed:\n", "  3.0.100 [/usr/local/share/dotnet/sdk]\n", "  3.0.101 [/usr/local/share/dotnet/sdk]\n", "  3.1.424 [/usr/local/share/dotnet/sdk]\n", "  5.0.402 [/usr/local/share/dotnet/sdk]\n", "  6.0.200 [/usr/local/share/dotnet/sdk]\n", "  6.0.301 [/usr/local/share/dotnet/sdk]\n", "  7.0.102 [/usr/local/share/dotnet/sdk]\n", "\n", ".NET runtimes installed:\n", "  Microsoft.AspNetCore.App 3.0.1 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]\n", "  Microsoft.AspNetCore.App 3.1.30 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]\n", "  Microsoft.AspNetCore.App 5.0.11 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]\n", "  Microsoft.AspNetCore.App 6.0.2 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]\n", "  Microsoft.AspNetCore.App 6.0.6 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]\n", "  Microsoft.AspNetCore.App 7.0.2 [/usr/local/share/dotnet/shared/Microsoft.AspNetCore.App]\n", "  Microsoft.NETCore.App 3.0.1 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]\n", "  Microsoft.NETCore.App 3.1.30 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]\n", "  Microsoft.NETCore.App 5.0.11 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]\n", "  Microsoft.NETCore.App 5.0.17 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]\n", "  Microsoft.NETCore.App 6.0.2 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]\n", "  Microsoft.NETCore.App 6.0.6 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]\n", "  Microsoft.NETCore.App 7.0.2 [/usr/local/share/dotnet/shared/Microsoft.NETCore.App]\n", "\n", "Other architectures found:\n", "  None\n", "\n", "Environment variables:\n", "  Not set\n", "\n", "global.json file:\n", "  Not found\n", "\n", "Learn more:\n", "  https://aka.ms/dotnet/info\n", "\n", "Download .NET:\n", "  https://aka.ms/dotnet/download\n", "```\n"]}, {"attachments": {}, "cell_type": "markdown", "metadata": {}, "source": ["### Organization of code in .NET\n", "\n", "#### Projects\n", "They are collections of code in one of the .NET languages \u200b\u200b(VB,C#,F#). Typically one finds an XML structured text file with the project information. In F# they are files with the extension `.fsproj`\n", "\n", "\n", "#### Solutions\n", "They are collections of Projects that constitute a particular program."]}, {"attachments": {}, "cell_type": "markdown", "metadata": {}, "source": ["### Creating solutions and projects\n", "\n", "To create solutions or projects, the `dotnet new` command is used:\n", "\n", "```bash\n", "dotnet new --help\n", "```\n", "\n", "Suppose we want to create the `HelloWorld` solution:\n", "```bash\n", "dotnet new sln -o HolaMundo\n", "```\n", "> Note that the `dotnet new sln` command used with the `-o` option creates a directory where the solution is to be developed.\n", "The command\n", "```bash\n", "dotnet new list\n", "```\n", "shows all types of projects that can be created. In addition, new project templates (_templates_) can be installed.\n", "\n", "We are going to create two projects, a console application and a library.\n", "\n", "> While the project structure is left to the programmers' discretion, in general a `src` directory is created **within** the\n", "> directory where the solution is, where the projects will be created.\n", "\n", "first then we do\n", "\n", "```bash\n", "cd HolaMundo\n", "mkdir src\n", "```\n", "\n", "To create the console application, we execute:\n", "```bash\n", "dotnet new console -lang F# -o src/MyProject\n", "```\n", "while to create the library:\n", "```bash\n", "dotnet new classlib -lang F# -o src/MyLibrary\n", "```\n", "Finally, we add both projects to the solution:\n", "```bash\n", "dotnet sln add src/MyProject/MyProject.fsproj\n", "dotnet sln add src/MyLibrary/MyLibrary.fsproj\n", "```"]}, {"attachments": {}, "cell_type": "markdown", "metadata": {}, "source": ["The directory structure would look like this:\n", "\n", "```bash\n", ".\n", "\u2514\u2500\u2500 HolaMundo/\n", "    \u251c\u2500\u2500 src/\n", "    \u2502   \u251c\u2500\u2500 MyProject/\n", "    \u2502   \u2502   \u251c\u2500\u2500 bin/ \n", "    \u2502   \u2502   \u251c\u2500\u2500 obj/\n", "    \u2502   \u2502   \u251c\u2500\u2500 Program.fs \n", "    \u2502   \u2502   \u2514\u2500\u2500 MyProject.fsproj\n", "    \u2502   \u2514\u2500\u2500 MyLibrary/\n", "    \u2502       \u251c\u2500\u2500 obj/\n", "    \u2502       \u251c\u2500\u2500 Library.fs \n", "    \u2502       \u2514\u2500\u2500 MyLibrary.fsproj      \n", "    \u2514\u2500\u2500 HolaMundo.sln     \n", "```"]}, {"attachments": {}, "cell_type": "markdown", "metadata": {}, "source": ["### Pause: creating a repository\n", "\n", "It is always convenient to use `git` to maintain our code. Before we forget, we should believe\n", "the repository then on GitHub (or the cloud site where we will store the code). When creating it, we will obtain a\n", "`REMOTE_URL` (found on the green `<> Code` button).\n", "\n", "> When creating the repository on GitHub, it's a good idea to add _Visual Studio_ as .gitignore. Thus,\n", "> git will take care of ignoring temporary files that are created when compiling .NET code.\n", "\n", "Being in the `HelloWorld` directory:\n", "\n", "```bash\n", "git init \n", "```\n", "to create the local repository. Then it is convenient to add only the `.sln` solution file (we will add\n", "the rest of the files later, once we have `.gitignore` copied from the remote repo to the local one).\n", "\n", "```bash\n", "git add HolaMundo.sln\n", "git commit -am \"First Commit\"\n", "```\n", "\n", "We connect the local repo with the remote one:\n", "```bash \n", "$ git remote add origin REMOTE_URL\n", "# Sets the new remote\n", "$ git remote -v\n", "# Verifies the new remote URL\n", "```\n", "We tell `git` how we want it to mix what's new from different instances\n", "from our repository\n", "```bash\n", "git config pull.rebase false\n", "```\n", "At this point we have two repositories\n", "- The place, with its history given by the first commit `First Commit`\n", "- The remote, also with its own history, which was generated by creating the `README.md` and `.gitignore`\n", "\n", "So, we bring the modifications from the remote repository and mix its history with the local one:\n", "```bash\n", "git pull origin main --allow-unrelated-histories\n", "```\n", "> The `--allow-unrelated-histories` option is only needed in this situation, from here on, both\n", "> repositories share history.\n", "\n", "A text will appear to record this merge, typically we could put 'Merge histories of local and remote',\n", "For example.\n", "\n", "Now yes, with `.gitignore` in the local repo, we can add the sources\n", "```bash\n", "git add .\n", "```\n", "and then finish with\n", "```bash\n", "git commit -m \"Added srcs\"\n", "git push origin main\n", "```\n", "\n", "You can use `git push --set-upstream origin main` to avoid having to specify which branch you want to `pull`.\n", "\n", "\n", "[Here](https://docs.github.com/en/migrations/importing-source-code/using-the-command-line-to-import-source-code/adding-locally-hosted-code-to-github) are the full official instructions,\n", "pero [this page contains a better explanation](https://www.freecodecamp.org/news/create-and-sync-git-and-github-repositories/#how-to-create-a-remote-github-repository).\n"]}, {"attachments": {}, "cell_type": "markdown", "metadata": {}, "source": ["### Adding references\n", "\n", "If we now want to use our `My Library` library in our `MyProject` project, we have to add it as a reference:\n", "\n", "```bash\n", "cd src/MyProject\n", "dotnet add reference ../../src/MyLibrary/MyLibrary.fsproj\n", "```\n", "\n", "On the other hand, if we wanted to add an external library, for example `FSharp.Data`, we would have to do:\n", "\n", "```bash\n", "cd src/MyProject\n", "dotnet add package FSharp.Data\n", "```\n"]}], "metadata": {"language_info": {"name": "python"}, "orig_nbformat": 4}, "nbformat": 4, "nbformat_minor": 2}