Allow relative paths in scoped packages #12

GeorgeTaveras1231 · 2016-11-20T14:00:59Z

Currently, a path such as "@lennym/npm-sass-test-sass/child-file" errors out. This makes it work(referring to the first commit in this PR), but I have concerns about the growing complexity of the find function.

I'm thinking about abstracting some of the package details such as isScoped, name
, and entrypointLocation (currently known as the location var) into a Package constructor in order to test each of these details in isolation while also simplifying the implementation of find.

What do you think @lennym?

As I mentioned above, I gave a shot at refactoring the code to make it easier to test. I've yet to write unit tests for the logic but while digging into the code I found that a custom file resolution algorithm was being used. After some research, I found that node's own require function could be used to implement this. I like this because this is likely to stay compatible with node/npm future implementations. I tried to describe the changes in this PR 230e069

Finally, I wrote unit tests for all of the new code. It is all runnable via npm run unit-test.

I'm very glad to see that this tool exists, which makes me happy to contribute to it 😄 . @lennym let me know what you think, looking forward to hearing back.

The resolver module implements a path resolving algorithm that leverages node's own require. This has a couple benefits: * more likely to continue working as expected when features are introduced to npm/node * reduction of code duplication (npm/node already implements the module resolution we are interested in for this project) * allow the use of NODE_PATH variable to control module directory Additionally, `resolver` leverages `Package` and `Import` constructors which implement some of the same logic previously found on the `find` function in `lib/importer.js`. The benefit of creating these constructors will obvious when unit tests are introduced for this project. `Package`: implements logic related to retrieving package data, such as getting the package.json, and getting the sass 'main' file for a given package. `Import`: implements logic to make sense of a sass import.

This allows the tests to work consistently

Also improved style in tests

GeorgeTaveras1231 · 2016-11-22T00:53:59Z

Actually, may need to reconsider this change of implementation after considering issues with dependencies of dependencies...

GeorgeTaveras1231 · 2016-11-22T01:42:37Z

I have some thoughts in mind for a solution for the problem stated above. Will add tests for nested dependencies in the process since those are missing.

lennym · 2016-11-22T10:05:19Z

package.json

@@ -5,7 +5,8 @@
  "main": "index.js",
  "bin": "./bin/npm-sass",
  "scripts": {
-    "test": "mocha test/index.js"
+    "test": "NODE_PATH=$NODE_PATH:\"$(git rev-parse --show-toplevel)/test/fixtures/node_modules\" mocha test/index.js",
+    "unit-test": "mocha test/units/*.js"


Would you mind refactoring this a little to rename what is now the test task, and then have test run both of the existing test tasks?

That way we can get better coverage in CI.

lennym · 2016-11-22T10:08:40Z

Hi @GeorgeTaveras1231

Thank you so much for your work on this, it's really appreciated. I'm not actually using this module in any of my own projects at the moment (it was written to solve some problems at a former workplace), so it might take a while for me to establish whether it's working as intended.

Do you need a fix for the issue quickly? I'm happy to publish a pre-release version so you can use it straight away. Meanwhile I'll try to review as best I can.

My first quick review is very positive. I like the changes you've made to the general readability of the code. It's certainly a lot easier to follow than my efforts. Will try to look more in depth soon.

GeorgeTaveras1231 · 2016-11-22T15:30:57Z

Hey @lennym

Thanks for the response. I'm not in a rush to get this code. Currently, this is something I'm experimenting with, with the hopes that I can pitch it to my organization as a standard tool.

We are currently undergoing a re-architecture of the way we manage front-end assets and so far, the idea of using npm-sass seems really appealing, though I'm not 100% sure as of right now whether we will be using it at a large scale soon.

Don't feel rushed to publish any of it. I will fix the issue I stated above and work on a couple of experiments that do not require this PR to be merged.

If the experiments work out and my team members buy into the idea of using npm-sass regularly, I'd gladly take this project off your hands, especially if you feel burdened by maintaining something you do not use currently. Even if it for a temporary period. How would you feel about that?

Because string expansion is not compatible with all shells

This helps some of the async code easier to read

GeorgeTaveras1231 · 2016-11-25T19:17:34Z

@lennym I believe I am done making code changes to this branch. I updated the test scripts per your advice. Please let me know if there is anything else you would like for me to address.

The major changes since you last saw this PR are:

Brought back usage of findup to resolve nested dependencies
Introduced Promises for async operations in resolver module (This helped make some of the code clearer)
Introduced unit tests for resolving nested dependencies

There are some items that would make sense to address eventually but not as part of this PR.

Inconsistent indentation in tests and source files
Remove explicit references to'/' path separator from local function.

tshelburne · 2017-01-05T22:26:26Z

@lennym I just hit this as well - going to test my issue with @GeorgeTaveras1231 's fork and see if it works.

As a side note, @GeorgeTaveras1231, great work - my first time looking at this in a while and it's really clear coding. Love it.

tshelburne · 2017-01-05T22:53:02Z

@GeorgeTaveras1231 @lennym This does appear to work, but I was expecting the relative import to be relative to the "style" property from package.json rather than the module directory itself:

// assuming "style": "dist/scss/library.scss"

// relative to the "style" file
@import '@scope/library/variables/colors';

// relative to the package directory
@import '@scope/library/dist/scss/variables/colors';

My preference would be the former, but it's not a terrible change. That said, I would definitely request documentation for this.

lennym · 2017-01-06T09:24:21Z

Thanks so much for your ongoing work on this @GeorgeTaveras1231 and @tshelburne.

In reference to the options provided above by @tshelburne, I'd actually have a very strong preference for the second one as it works in the same way as require in node when require-ing a non-main module from within a package. My intention for npm-sass has always been for @import to work like require as much as possible.

I should have some time next week to set aside to reviewing this properly, with a view to merging and releasing.

lennym · 2017-02-01T11:40:23Z

package.json

-    "test": "mocha test/index.js"
+    "test": "mocha $npm_package_config_unit_test_files $npm_package_config_integration_test_files",
+    "unit-test": "mocha $npm_package_config_unit_test_files",
+    "integration-test": "mocha $npm_package_config_integration_test_files"


TIL. Thanks @GeorgeTaveras1231!

lennym · 2017-02-01T11:46:29Z

Thank you so much for your work on this @GeorgeTaveras1231, I really appreciate it.

I will take some time to address some of your further points above today.

lennym · 2017-02-01T12:43:49Z

I've published your changes with a major version bump to v2.0.0

Thanks again for contributing.

Allow relative paths in scoped packages

ec16eb2

GeorgeTaveras1231 mentioned this pull request Nov 21, 2016

Windows. Ugh... #7

Open

GeorgeTaveras1231 added 2 commits November 20, 2016 19:48

Fix test run

9dab304

This allows the tests to work consistently

GeorgeTaveras1231 force-pushed the master branch from 2e928e4 to 1c4ce24 Compare November 21, 2016 02:14

GeorgeTaveras1231 added 3 commits November 20, 2016 21:18

Add Package unit tests and unit test script

1c4ce24

Add unit tests for Import

a8cad50

Add unit tests for resolver

4b4fdcf

GeorgeTaveras1231 force-pushed the master branch from e9e7f34 to 17e3c65 Compare November 21, 2016 02:56

Attempt to be cross platform friendly

17e3c65

Also improved style in tests

GeorgeTaveras1231 force-pushed the master branch from 862267c to 3dace1a Compare November 21, 2016 03:02

Ignore log files and vim swap files

3dace1a

lennym reviewed Nov 22, 2016

View reviewed changes

GeorgeTaveras1231 added 9 commits November 24, 2016 13:38

Use findup implementation again to properly resolve nested dependencies

d61b2c4

Update unit tests for Package and resolver

ca314c7

Refactor test scripts to run all tests with npm t

df955e5

Remove unused dependency

66f9799

Remove string expansion fron test script

3b89108

Because string expansion is not compatible with all shells

Make indentation consistent across source files

f7bad67

Only ignore node_modules in test-cases and root of project

f0a7a90

Remove unnecessary fixture files

550fff0

Avoid blocking the event loop

f74e5bf

GeorgeTaveras1231 force-pushed the master branch from 525dbba to 0375885 Compare November 25, 2016 19:04

GeorgeTaveras1231 added 2 commits November 25, 2016 14:07

Introduce Promises for async operations

0375885

This helps some of the async code easier to read

Handle exception in nearestPackageRoot test

3084a15

lennym reviewed Feb 1, 2017

View reviewed changes

lennym merged commit fe7c03f into lennym:master Feb 1, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow relative paths in scoped packages #12

Allow relative paths in scoped packages #12

GeorgeTaveras1231 commented Nov 20, 2016 •

edited

Loading

GeorgeTaveras1231 commented Nov 22, 2016

GeorgeTaveras1231 commented Nov 22, 2016

lennym Nov 22, 2016

lennym commented Nov 22, 2016 •

edited

Loading

GeorgeTaveras1231 commented Nov 22, 2016

GeorgeTaveras1231 commented Nov 25, 2016 •

edited

Loading

tshelburne commented Jan 5, 2017

tshelburne commented Jan 5, 2017 •

edited

Loading

lennym commented Jan 6, 2017

lennym Feb 1, 2017

lennym commented Feb 1, 2017 •

edited

Loading

lennym commented Feb 1, 2017

Allow relative paths in scoped packages #12

Allow relative paths in scoped packages #12

Conversation

GeorgeTaveras1231 commented Nov 20, 2016 • edited Loading

GeorgeTaveras1231 commented Nov 22, 2016

GeorgeTaveras1231 commented Nov 22, 2016

lennym Nov 22, 2016

Choose a reason for hiding this comment

lennym commented Nov 22, 2016 • edited Loading

GeorgeTaveras1231 commented Nov 22, 2016

GeorgeTaveras1231 commented Nov 25, 2016 • edited Loading

tshelburne commented Jan 5, 2017

tshelburne commented Jan 5, 2017 • edited Loading

lennym commented Jan 6, 2017

lennym Feb 1, 2017

Choose a reason for hiding this comment

lennym commented Feb 1, 2017 • edited Loading

lennym commented Feb 1, 2017

GeorgeTaveras1231 commented Nov 20, 2016 •

edited

Loading

lennym commented Nov 22, 2016 •

edited

Loading

GeorgeTaveras1231 commented Nov 25, 2016 •

edited

Loading

tshelburne commented Jan 5, 2017 •

edited

Loading

lennym commented Feb 1, 2017 •

edited

Loading