add script path

[laggingreflex]

If you specify option "scriptPath": true:

"plugins": [
  ["annotate-console-log", {
    "scriptPath": true
  }]
]

it'll add a short script path (and line number)

console.log('hi')
// =>
console.log('[file.js:3]', 'foo()', 'hi')

If the filename was index.js it'll ad the parent foldername

console.log('[foo/index.js:5]', 'foo()', 'hi')

Use "fullScriptPath": true to add more detailed script path info

console.log('foo()', 'hi', {
  scriptColumn: 4,
  scriptLine: 9,
  scriptPath: 'relative/to/nearest/package.json/full-script-path/index.js'
})

fixes #1

[laggingreflex]

@gajus thoughts on this? I was also thinking maybe having only this (the short script path) without the function name. What would you say about making the function name optional, like {functionName: false, scriptPath: true}

[gajus]

Whats the reason for wanting to include the file name, line, column if this information is already present in the console?

As is "VM214:1" in this screenshot.

[laggingreflex]

I'm using this in Node

[gajus]

Whats the reason for needing to wrap the path in square brackets?

[gajus]

Whats the reason for not including the column?

[gajus]

Whats the reason for representing this as an object, as opposed to a single string scriptPath:line:column?

I know thats what I do at https://github.com/gajus/babel-plugin-log-deprecated
though I am not necessarily a good developer to follow by example. :-(

Representing it as a single string will enable you to click–open in IDE the file at a specified line, column (e.g. https://coderwall.com/p/0kapug/iterm2-open-text-file-paths-in-sublime-text-with-jump-to-line-number)

[gajus]

I don't like that fullScriptPath behaves different from scriptPath, i.e. one adds path as the first parameter of console.log, the second one adds it as an object to the end. I'd rather that scriptPath would always add a string path as the first parameter. Use it in combination with scriptPathStyle (ENUM 'relative' | 'fileName').

[laggingreflex]

I like this idea. To clarify, 'fileName' would be just foo.js, and 'relative' would be relative to the project root, right? Should there also be an option 'fullpath' for actual full path? You mentioned above "iterm2-open-text-file-paths", I'm not familiar with it but would it require full path?

[laggingreflex]

Made it a single setting scriptPath: 'relative' | 'filename' | 'fullpath'

[gajus]

You mentioned above "iterm2-open-text-file-paths", I'm not familiar with it but would it require full path?

Not necessarily. Depends on the PWD.

[gajus]

Add type definition for:

type OptionsType = {
  scriptPath: 'filename' | 'fullpath' | 'relative'
};

const opts: OptionsType = state.opts;