Consolidate foam-core within foam-vscode (foambubble#774)

* moved `foam-core` inside `foam-vscode`

* updated contribution guide to reflect new modules setup

* improved testing

* consolidate to root yarn.lock files

* tweaking CI workflow && using github secrets to force cache refresh

* improved linting configuration. `core` module cannot depend on other parts of the `foam-vscode` package

.eslintrc.json

@@ -1,20 +1,18 @@
 {
- "root": true,
- "parser": "@typescript-eslint/parser",
- "parserOptions": {
- "ecmaVersion": 6,
- "sourceType": "module"
- },
- "plugins": [
- "@typescript-eslint"
- ],
- "rules": {
- "@typescript-eslint/class-name-casing": "warn",
- "@typescript-eslint/semi": "warn",
- "curly": "warn",
- "eqeqeq": "warn",
- "no-throw-literal": "warn",
- "semi": "off",
- "require-await": "warn"
- }
+ "root": true,
+ "parser": "@typescript-eslint/parser",
+ "parserOptions": {
+ "ecmaVersion": 6,
+ "sourceType": "module"
+ },
+ "plugins": ["@typescript-eslint", "import"],
+ "rules": {
+ "@typescript-eslint/class-name-casing": "warn",
+ "@typescript-eslint/semi": "warn",
+ "curly": "warn",
+ "eqeqeq": "warn",
+ "no-throw-literal": "warn",
+ "semi": "off",
+ "require-await": "warn"
+ }
 }

.github/workflows/ci.yml

@@ -3,17 +3,15 @@ name: CI
 on:
  push:
  branches:
- - '**'
- # The following will also make the workflow run on all PRs, internal and external.
- # This would create duplicate runs, that we are skipping by adding the "if" to the jobs below.
- # See https://github.community/t/duplicate-checks-on-push-and-pull-request-simultaneous-event/18012
+ - master
  pull_request:
+ branches:
+ - master
 
 jobs:
  lint:
  name: Lint
  runs-on: ubuntu-18.04
- if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'foambubble/foam'
  steps:
  - uses: actions/checkout@v1
  - name: Setup Node
@@ -27,7 +25,7 @@ jobs:
  node_modules
  */*/node_modules
  packages/foam-vscode/.vscode-test
- key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}
+ key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}-${{ secrets.CACHE_VERSION }}
  - name: Install Dependencies
  run: yarn
  - name: Check Lint Rules
@@ -39,7 +37,6 @@ jobs:
  matrix:
  os: [macos-10.15, ubuntu-18.04, windows-2019]
  runs-on: ${{ matrix.os }}
- if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != 'foambubble/foam'
  env:
  OS: ${{ matrix.os }}
  steps:
@@ -55,7 +52,7 @@ jobs:
  node_modules
  */*/node_modules
  packages/foam-vscode/.vscode-test
- key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}
+ key: ${{ runner.os }}-${{ hashFiles('**/yarn.lock', 'packages/foam-vscode/src/test/run-tests.ts') }}-${{ secrets.CACHE_VERSION }}
  - name: Install Dependencies
  run: yarn
  - name: Build Packages

.vscode/tasks.json

@@ -1,31 +1,31 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
- "version": "2.0.0",
- "tasks": [
- {
- "label": "watch: foam-vscode",
- "type": "npm",
- "script": "start:vscode",
- "problemMatcher": "$tsc-watch",
- "isBackground": true,
- "presentation": {
- "reveal": "always"
- },
- "group": {
- "kind": "build",
- "isDefault": true
- }
- },
- {
- "label": "test: all packages",
- "type": "npm",
- "script": "test",
- "problemMatcher": [],
- "group": {
- "kind": "test",
- "isDefault": true
- },
- }
- ]
+ "version": "2.0.0",
+ "tasks": [
+ {
+ "label": "watch: foam-vscode",
+ "type": "npm",
+ "script": "watch",
+ "problemMatcher": "$tsc-watch",
+ "isBackground": true,
+ "presentation": {
+ "reveal": "always"
+ },
+ "group": {
+ "kind": "build",
+ "isDefault": true
+ }
+ },
+ {
+ "label": "test: all packages",
+ "type": "npm",
+ "script": "test",
+ "problemMatcher": [],
+ "group": {
+ "kind": "test",
+ "isDefault": true
+ }
+ }
+ ]
 }

docs/contribution-guide.md

@@ -18,8 +18,6 @@ Before you start contributing we recommend that you read the following links:
 We understand that diving in an unfamiliar codebase may seem scary,
 to make it easier for new contributors we provide some resources:
 
-- [[architecture]] - This document describes the architecture of Foam and how the repository is structured.
-
 You can also see [existing issues](https://github.com/foambubble/foam/issues) and help out!
 Finally, the easiest way to help, is to use it and provide feedback by [submitting issues](https://github.com/foambubble/foam/issues/new/choose) or participating in the [Foam Community Discord](https://foambubble.github.io/join-discord/g)!
 
@@ -35,22 +33,48 @@ If you're interested in contributing, this short guide will help you get things
 
  `yarn install`
 
-3. This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/). `foam-vscode` relies on `foam-core`. This means we need to compile it before we do any extension development. From the root, run the command:
+3. From the root, run the command:
 
  `yarn build`
 
 You should now be ready to start working!
 
+### Structure of the project
+
+Foam code and documentation live in the monorepo at [foambubble/foam](https://github.com/foambubble/foam/).
+
+- [/docs](https://github.com/foambubble/foam/tree/master/docs): documentation and [[recipes]].
+
+Exceptions to the monorepo are:
+
+- The starter template at [foambubble/foam-template](https://github.com/foambubble/)
+- All other [[recommended-extensions]] live in their respective GitHub repos
+
+This project uses [Yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/). 
+
+Originally Foam had:
+
+- [/packages/foam-core](https://github.com/foambubble/foam/tree/master/packages/foam-core) - Powers the core functionality in Foam across all platforms.
+- [/packages/foam-vscode](https://github.com/foambubble/foam/tree/master/packages/foam-vscode) - The core VS Code plugin.
+
+To improve DX we have moved the `foam-core` module into `packages/foam-vscode/src/core`, but from a development point of view it's useful to think of the `foam-vscode/src/core` "submodule" as something that might be extracted in the future.
+
+For all intents and purposes this means two things:
+
+1. nothing in `foam-vscode/src/core` should depend on files outside of this directory
+2. code in `foam-vscode/src/core` should NOT depend on `vscode` library
+
+We have kept the yarn workspace for the time being as we might use it to pull out `foam-core` in the future, or we might need it for other packages that the VS Code plugin could depend upon (e.g. currently the graph visualization is inside the module, but it might be pulled out if its complexity increases).
+
 ### Testing
 
 Code needs to come with tests.
 We use the following convention in Foam:
 
-- *.test.ts are unit tests
-- *.spec.ts are integration tests
+- `*.test.ts` are unit tests
+- `*.spec.ts` are integration tests
 
-Also, note that tests in `foam-core` live in the `test` directory.
-Tests in `foam-vscode` live alongside the code in `src`.
+Tests live alongside the code in `src`.
 
 ### The VS Code Extension
 
@@ -71,5 +95,6 @@ Feel free to modify and submit a PR if this guide is out-of-date or contains err
 [//begin]: # "Autogenerated link references for markdown compatibility"
 [principles]: principles.md "Principles"
 [code-of-conduct]: code-of-conduct.md "Code of Conduct"
-[architecture]: dev/architecture.md "Architecture"
+[recipes]: recipes/recipes.md "Recipes"
+[recommended-extensions]: recommended-extensions.md "Recommended Extensions"
 [//end]: # "Autogenerated link references"

package.json

@@ -9,10 +9,6 @@
  "packages/*"
  ],
  "scripts": {
- "start:vscode": "yarn workspace foam-vscode vscode:start-debugging",
- "build:core": "yarn workspace foam-core build",
- "watch:core": "yarn workspace foam-core start",
- "test:core": "yarn workspace foam-core test",
  "vscode:package-extension": "yarn workspace foam-vscode package-extension",
  "vscode:install-extension": "yarn workspace foam-vscode install-extension",
  "vscode:publish-extension": "yarn workspace foam-vscode publish-extension",