{"id":20720225,"url":"https://github.com/zaaack/vscode-fsharp-format-provider","last_synced_at":"2025-06-23T01:35:07.946Z","repository":{"id":74324930,"uuid":"103796162","full_name":"zaaack/vscode-fsharp-format-provider","owner":"zaaack","description":"FSharp format provider for vscode using fantomas.","archived":false,"fork":false,"pushed_at":"2017-09-20T10:32:15.000Z","size":142,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-11T07:52:40.887Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"F#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zaaack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-17T02:01:48.000Z","updated_at":"2017-12-13T09:28:14.000Z","dependencies_parsed_at":null,"dependency_job_id":"eca3ac99-f7f9-4496-b7bf-948caa2eab15","html_url":"https://github.com/zaaack/vscode-fsharp-format-provider","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/zaaack/vscode-fsharp-format-provider","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaaack%2Fvscode-fsharp-format-provider","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaaack%2Fvscode-fsharp-format-provider/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaaack%2Fvscode-fsharp-format-provider/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaaack%2Fvscode-fsharp-format-provider/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zaaack","download_url":"https://codeload.github.com/zaaack/vscode-fsharp-format-provider/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zaaack%2Fvscode-fsharp-format-provider/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261395957,"owners_count":23152439,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-17T03:19:41.487Z","updated_at":"2025-06-23T01:35:02.932Z","avatar_url":"https://github.com/zaaack.png","language":"F#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fable Simple Template\n\nThis template can be used to generate a simple web app with [Fable](http://fable.io/).\nYou can find more templates by searching `Fable.Template` packages in [Nuget](https://www.nuget.org).\n\n## Requirements\n\n* [dotnet SDK](https://www.microsoft.com/net/download/core) 2.0 or higher\n* [node.js](https://nodejs.org) 6.11 or higher\n* A JS package manager: [yarn](https://yarnpkg.com) or [npm](http://npmjs.com/)\n\n\u003e npm comes bundled with node.js, but we recommend to use at least npm 5. If you have npm installed, you can upgrade it by running `npm install -g npm`.\n\nAlthough is not a Fable requirement, on macOS and Linux you'll need [Mono](http://www.mono-project.com/) for other F# tooling like Paket or editor support.\n\n## Editor\n\nThe project can be used by editors compatible with the new .fsproj format, like VS Code + [Ionide](http://ionide.io/), Emacs with [fsharp-mode](https://github.com/fsharp/emacs-fsharp-mode) or [Rider](https://www.jetbrains.com/rider/). **Visual Studio for Mac** is also compatible but in the current version the package auto-restore function conflicts with Paket so you need to disable it: `Preferences \u003e Nuget \u003e General`.\n\n## Installing the template\n\nIn a terminal, run `dotnet new -i Fable.Template` to install or update the template to the latest version.\n\n## Creating a new project with the template\n\nIn a terminal, run `dotnet new fable` to create a project in the current directory. Type `dotnet new fable -n MyApp` instead to create a subfolder named `MyApp` and put the new project there.\n\n\u003e The project will have the name of the directory. You may get some issues if the directory name contains some special characters like hyphens\n\n## Building and running the app\n\n\u003e In the commands below, yarn is the tool of choice. If you want to use npm, just replace `yarn` by `npm` in the commands.\n\n* Install JS dependencies: `yarn install`\n* **Move to `src` folder**: `cd src`\n* Install F# dependencies: `dotnet restore`\n* Start Fable daemon and [Webpack](https://webpack.js.org/) dev server: `dotnet fable yarn-start`\n* In your browser, open: http://localhost:8080/\n\n\u003e `dotnet fable yarn-start` (or `npm-start`) is used to start the Fable daemon and run a script in package.json concurrently. It's a shortcut of `yarn-run [SCRIPT_NAME]`, e.g. `dotnet fable yarn-run start`.\n\nIf you are using VS Code + [Ionide](http://ionide.io/), you can also use the key combination: Ctrl+Shift+B (Cmd+Shift+B on macOS) instead of typing the `dotnet fable yarn-start` command. This also has the advantage that Fable-specific errors will be highlighted in the editor along with other F# errors.\n\nAny modification you do to the F# code will be reflected in the web page after saving. When you want to output the JS code to disk, run `dotnet fable yarn-build` and you'll get a minified JS bundle in the `public` folder.\n\n## Project structure\n\n### Paket\n\n[Paket](https://fsprojects.github.io/Paket/) is the package manager used for F# dependencies. It doesn't need a global installation, the binary is included in the `.paket` folder. Other Paket related files are:\n\n- **paket.dependencies**: contains all the dependencies in the repository.\n- **paket.references**: there should be one such a file next to each `.fsproj` file.\n- **paket.lock**: automatically generated, but should be committed to source control, [see why](https://fsprojects.github.io/Paket/faq.html#Why-should-I-commit-the-lock-file).\n- **Nuget.Config**: prevents conflicts with Paket in machines with some Nuget configuration.\n\n\u003e Paket dependencies will be installed in the `packages` directory. See [Paket website](https://fsprojects.github.io/Paket/) for more info.\n\n### yarn/npm\n\n- **package.json**: contains the JS dependencies together with other info, like development scripts.\n- **yarn.lock**: is the lock file created by yarn.\n- **package-lock.json**: is the lock file understood by npm 5, if you use it instead of yarn.\n\n\u003e JS dependencies will be installed in `node_modules`. See [yarn](https://yarnpkg.com) and/or [npm](http://npmjs.com/) websites for more info.\n\n### Webpack\n\n[Webpack](https://webpack.js.org) is a bundler, which links different JS sources into a single file making deployment much easier. It also offers other features, like a static dev server that can automatically refresh the browser upon changes in your code or a minifier for production release. Fable interacts with Webpack through the `fable-loader`.\n\n- **webpack.config.js**: is the configuration file for Webpack. It allows you to set many things: like the path of the bundle, the port for the development server or [Babel](https://babeljs.io/) options. See [Webpack website](https://webpack.js.org) for more info.\n\n### F# source files\n\nThe template only contains two F# source files: the project (.fsproj) and a source file (.fs) in `src` folder.\n\n## Where to go from here\n\nCheck more [Fable samples](https://github.com/fable-compiler/samples-browser), use another template like `Fable.Template.Elmish.React` or clone the [fable-suave-scaffold](https://github.com/fable-compiler/fable-suave-scaffold).","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaaack%2Fvscode-fsharp-format-provider","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzaaack%2Fvscode-fsharp-format-provider","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzaaack%2Fvscode-fsharp-format-provider/lists"}