@lls/vitescripts 1.1.0 → 1.1.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lls/vitescripts",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "lls vite plugins",
   "main": "src/index.mjs",
   "files": [

package/src/llsAssetsPlugin.mjs

@@ -5,6 +5,13 @@ import path from 'path'
 const execP = promisify(exec)
 
 // https://github.com/vitejs/vite/pull/8574
+/**
+ * Plugin that will copy assets from given repos to public dir of launched project
+ * @param {*} llsRepos array containing names of the repos
+ * @param {*} publicDir public dir to copy assets to
+ * @returns config() method that copies assets
+ * transform() method that replaces assets path to be resolved
+ */
 const llsAssetsPlugin = (llsRepos, publicDir = 'ladleassets') => {
   const publicAssetDir = path.join(publicDir, 'assets')
   const fileExists = (s) => new Promise(resolve => fs.access(s, e => resolve(!e)))
@@ -12,7 +19,7 @@ const llsAssetsPlugin = (llsRepos, publicDir = 'ladleassets') => {
   const storyRoot = process.cwd() + '/stories'
   return {
     name: 'lls:copyassets',
-    async config(conf, { command }) {
+    async config() {
       await execP(`mkdir -p ${publicAssetDir}`)
       const repoArgs = await Promise.all(llsRepos.map(async repo => {
         if (!repo.startsWith('@')) return repo

package/src/llsLinariaSsrCollectPlugin.mjs

@@ -1,3 +1,9 @@
+/**
+ * Plugin that collects styles from linaria cache to inject it in the page.
+ * @returns config() method that instantiates linariaPlugin
+ * resolveId() method that filters files to be added to css set
+ * flushStyles() method that generates and return <style> tag with refreshed style
+ */
 const llsLinariaSsrCollectPlugin = () => {
   const cssIds = new Set()
   let linariaPlugin
@@ -9,9 +15,13 @@ const llsLinariaSsrCollectPlugin = () => {
     async resolveId(id, from) {
       if (id.includes('@linaria-cache')) { cssIds.add(id) }
     },
+    flushStyles() {
+      const back = `<style id="linaria-ssr-collect-plugin">${[...cssIds].map(linariaPlugin.load).join('\n')}</style>`
+      // linaria plugin keeps cache. But we dont want to keep ids which have changed (updating a css component)
+      // css is removed from client anyway but still be accurate
+      cssIds.clear()
 
-    collectSsrStyles() {
-      return `<style>${[...cssIds].map(linariaPlugin.load).join('\n')}</style>`
+      return back
     }
   }
 }

package/src/llsRequirePlugin.mjs

@@ -1,7 +1,12 @@
 import VitePluginRequireTransform from 'vite-plugin-require-transform'
 
-// needed for viewer if siderefresh
+/**
+ * Plugin using vite-plugin-require-transform, used to transform require syntax to import
+ * Needed when we use viewer in sideRefresh
+ * @returns the plugin with its transform method
+ */
 const llsSsrRequirePlugin = () => {
+  // Lazy loaded viewer modules that are using require syntax
   const fileRegex = /(?:(Audio|Recorder|Python|Video|QuestionRich|CodemirrorEditor|useLazyModule)\.jsx$|@lls_lls-code)/
   const back = VitePluginRequireTransform({ fileRegex })
   return {
@@ -19,4 +24,4 @@ const llsSsrRequirePlugin = () => {
   }
 }
 
-export default llsSsrRequirePlugin
+export default llsSsrRequirePlugin

package/src/llsSideRefreshMetaPlugin.mjs

@@ -9,6 +9,7 @@ const pwd = process.cwd()
  */
 const llsSideRefreshMetaPlugin = ({ viewer: iViewer, superkit: iSuperkit, kit: iKit, utils: iUtils }) => {
   if (!iViewer && !iSuperkit && !iKit && !iUtils) { return { plugin: () => false, alias: {} } }
+  // eslint-disable-next-line no-console
   console.log('sideResfresh: ', [
     iViewer && 'viewer',
     iSuperkit && 'superkit',