Consistent import paths for pug & sass

ideolumo / nox

A opinionated self contained static site generator using pug, sass & gulp

GNU General Public License v2.0

1 stars 0 forks source link

Consistent import paths for pug & sass #14

Open Jikstra opened 6 years ago

Jikstra commented 6 years ago

Currently in sass we have to do something like: @import template/blubb.sass to import /src/template/blubb.sass while in pug we do include /template/blubb.sass to import /src/template/blubb.sass. Both should start with an / for absolute (relative to the source folder) imports

Jikstra commented 5 years ago

To have consistent import resolving methods, we need to patch them for pug, sass and the require for js. How to overwrite the resolve methods:

pug https://github.com/markbrouch/pug-plugin-modules https://github.com/pugjs/pug/issues/2164#issuecomment-240675647
sass https://github.com/sass/node-sass#importer--v200---experimental
js as simple as redefining require, maybe it's not a good idea to do this

Jikstra commented 5 years ago

With a consistent resolve method, features like this would be nice:

@npm/nox-component-xyz import something from a npm module
@composer/nox-component-foo import something from a composer module
@ROOT/node_modules/xyz/blubb/foo.pug import something from the ROOT folder (where package.json is in)

Jikstra commented 5 years ago

A consistent importer should also allow this:

absolute imports (eg doing /template/blubb) resolves to the /path/to/nox/project/src/template/blubb
relative imports resolve to whereever the file currently processed lays
If we want to import a directory, in .pug it should look for a index.pug file, for sass for a index.sass file. (eg: /template/a-folder should resolve to /template/a-folder/index.pug/sass)