polylith

polylith copied to clipboard

This PR adds ClojureScript support to the poly tool. There is a longer discussion explaining the rationale behind here.

Some of the decisions to keep the scope of the changes small without compromising the overall value:

• All components, bases, and projects live under a single Polylith monorepo regardless of the dialects used within them.
• The components and bases can mix clj, cljs, and cljc files in their source files.
• The workspace.edn will have a new config option called :dialects to let users restrict dialects in their workspace.
• The poly tool will also read cljs files, in addition to the cljc and clj files, if cljs is enabled in the current workspace.
• A component or base with a modified file will be marked as changed regardless of the dialect. As a result, all dependent components will be marked as indirectly changed.
• We decided to leave testing out of scope and rely on shadow-cljs or similar for testing.
• The Polylith team will provide a simple development setup for a mixed (or ClojureScript only) workspace using shadow-cljs. The users can choose their own way to create a classpath and start their own clj/cljs REPLs.

---

TODOs:

• [x] Add dialects to workspace config
  • The :dialects config option works as follows. The user can define a set of dialects. Valid dialects are: "clj" and "cljs". If the dialects option is not defined or if it's an empty set, it will be treated as if it is #{"clj"}. This is necessary for backward compatibility. If it is #{"clj", "cljs}, .clj, .cljs, and .cljc files will be considered as valid code sources.
• [x] Handle require-macros case
  • ClojureScript files can require macros from clj files using :require-macros.
• [x] Ensure the default test runner works without breaking
  • The external test runner will need an update for ClojureScript-enabled workspaces.
• [ ] Handle NPM dependencies in the libs command
  • Read the package.json files and include those dependencies in the libs command.
  • Each brick and project should have a package.json if they use NPM dependencies.
• [ ] Update the create command to support creating ClojureScript bricks and projects.
• [x] Add an example project under examples with corner cases.
  • Project should contain:
    • A component with only clj sources
    • A component with clj and cljc sources
    • A component with clj, cljs, and cljc sources
    • A component with only cljs sources
    • A component with a cljs source and an accompanying clj source with macro definitions. The cljs file should require a clj file using require-macros. There should be additional clj files that the main clj file that contains the macros should require regularly.
• [ ] Create a sample development environment & projects with shadow-cljs
• [x] Update the documentation
  • Explain :dialects key
  • Explain how to work with ClojureScript (new section)
• [ ] Update the FAQ for ClojureScript support (gitbook)