Fix npm/browserify usage

[TooTallNate]

Other plugins are doing define('scribe-common/element'), so for this to work in npm/browserify then we need the element.js file to be located at the root of the repository.

Also set the package.json's "main" to element.js, since there is no scribe-common.js file, and element.js appears to be the only JS file in the repo at the moment.

[TooTallNate]

@OliverJAsh ping

[OliverJAsh]

Hmm, I’m not sure whether we should do this, or update the RequireJS path to scribe-common in the other plugins: https://github.com/guardian/scribe-plugin-smart-lists/blob/master/Plumbing.js#L16

[TooTallNate]

@OliverJAsh Ya I was contemplating that same dilemma. I decided to just fix it here since it would be just 1 pull request instead of n (there's at least 2 plugins using this modules that I can think of off the top of my head).

If you'd rather fix at the plugin level then I'm fine with that as well, and we can send PRs to the individual plugins. Just let me know how you would like to proceed.

[TooTallNate]

Ping. With guardian/scribe#195 in the pipeline, I'm gonna need this working.

[OliverJAsh]

Now that we have two files, it doesn't make sense to change to the main to element.js.

What’s the alternative solution?

[TooTallNate]

The alternative is to just remove "main" completely. In all usage I've seen of this module so far, a sub-file is required directly instead of the main package ("scribe-common/node"), so we can safely remove it.

[OliverJAsh]

I’m happy to do that if you are?

[TooTallNate]

@OliverJAsh Sure thing. PR updated.

[TooTallNate]

Bump.

[lrowe]

I'd like to promote #4 as a better alternative to this as it makes scribe-common/element and scribe-common/node commonjs modules. (See my post to the google group.)

[OliverJAsh]

The src folder is useful to have. I don't want to remove that.

The issue is that, with the current setup, the browserify require points to node_modules/scribe-common (npm module) whereas the RequireJS require points to bower_components/scribe-common/src. Thus, a require for scribe-common/element will point to:

• node_modules/scribe-common/element.js in browserify
• bower_components/scribe-common/src/element.js in RequireJS

I imagine there would be similar issues when scribe-plugin-sanitizer tries to load html-janitor: https://github.com/guardian/scribe-plugin-sanitizer/blob/master/src/scribe-plugin-sanitizer.js#L2

I propose that we:

1. Remove the main from package.json, as you have done here, so that a require for scribe-common in browserify will try to load scribe-common/index.js (non-existent)
2. Update the RequireJS path for scribe-common from bower_components/scribe-common/src to bower_components/scribe-common so that requiring in both browserify and RequireJS will consistently try to load the same file
3. Update all scribe-common require calls to lookup files in the src folder, e.g. define(['scribe-common/element'], …) => define(['scribe-common/src/element'], …)

Whatever solution we go with, we should use it consistently across the Scribe ecosystem.

All of this sucks 😒

[TooTallNate]

@OliverJAsh Albeit taking the most work, that does indeed sound like the best solution to me.

[samvasko]

Oliver, but some modules are using element that is directly is scribe repository. What's up with that?

[OliverJAsh]

That's a different element module, so that's fine.

[TooTallNate]

@OliverJAsh Ok, so this PR has been reduced to just removing the main field from the package.json. All other "fixes" need to be done in the other repos.

[OliverJAsh]

v0.0.5 is out!