Uploaded image for project: 'Magnolia CLI'
  1. Magnolia CLI
  2. NPMCLI-81

Identify best practice for files not used by magnolia

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Neutral
    • None
    • None
    • None
    • Basel 84
    • 1

    Description

      There are several instances of files that are related to a light module, that are not directly used by magnolia. Where should they be stored? How should these files be handled?

      While we must preserve the freedom for developers to handle the files however they want - we should provide a convention so that light modules can be easily shared, understood, and used.

      To keep in mind is both the case of companies developing a library of modules for in-house use, and in particular of developers sharing components in places like github and npm.

      Some questions:

      • Should all the files be stored in the light module? Or should some of the files be stored in a separate location?
      • Where should tests be stored?
      • Where are examples stored?
      • Where are files to be processed - like less, sass, ES6, TS stored?
      • If all the files are in the light module - should something be done to remove them when using them in production - for security, tidiness, and to minimize resource consumption of the file watcher?

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              rkowalski Robert Kowalski
              czimmermann Christopher Zimmermann
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR