templates/*/node_modules should be ignored #189

Activity

1. AriPerkkio

   added

   bugSomething isn't workingSomething isn't working

   on Jul 30, 2024
2. AriPerkkio

   changed the title [-]`template/*/node_modules` should be ignored[/-] [+]`templates/*/node_modules` should be ignored[/+] on Jul 30, 2024
3. AriPerkkio commented on Jul 30, 2024

   

   AriPerkkio

   on Jul 30, 2024

   ContributorAuthor

   More actions

   Though it's completely valid use case to add pre-optimized node_modules into templates to make tutorials load faster.

   To get the best user experience here, we should ignore templates/*/node_modules by default. Including templates/*/node_modules should be possible by opt-in option. Maybe after #165 we could have:

   template:
     name: my-template
     ignoredFiles: [] # Defaults to '**/node_modules**/', [] makes node_modules included
4. AriPerkkio commented on Aug 1, 2024

   

   AriPerkkio

   on Aug 1, 2024

   ContributorAuthor

   More actions

   So far I've tried two approaches:

   • Add template.ignoredFiles into metadata
     • This way we would still end up creating those 50MB <name>-template.json files, as exclusion would happen after the files have been loaded to the browser
   • Add ignoredFiles to .tk-config file, that is already used to configure src/templates
     • This would work well, but now it's not possible to set this in tutorial/part/chapter/lesson metadata
     • Implementing this into codebase is also a bit difficult now, but possible

   More users are now running into this so we should publish a release with quick fix as soon as possible. I think I'll make node_modules exclusion non-configurable now, and create a separate feature issue for configuring ignoredFile in metadata or .tk-config.json.
5. AriPerkkio

   closed this as completedin #198on Aug 1, 2024
6. noam-honig commented on Aug 1, 2024

   

   noam-honig

   on Aug 1, 2024

   Contributor

   More actions

   thanks