Please, provide a more descriptive example in the Usage section. about konan

[egoist]

hmm see https://github.com/egoist/konan#api

[sabsaxo]

Not sure I get this. You pass a file entry point ('path_to_file.js') to 'detective' ... I can't seem to understand this sentense:

Source content as string or AST tree.

What is 'Source content'? And I thought that an AST would be what I would get back from konan, not pass into it ... !?

So I ask again:

Can it be used like this?:

let result = konan( 'path/to/script_to_traverse.js' );

[sabsaxo]

I can only generate this error: Error: You must pass a scope and parentPath unless traversing a Program/File. Instead of that you tried to traverse a undefined node without passing scope and parentPath. Which does not help me in 'guessing' what to pass to the module. Maybe the 'Like detective but also supports ES6 import and more.' statement is not the right thing to state in the beginning of the readme. As it seem to give the wrong impression ...

[egoist]

Source content means the JS code/AST you want to traverse.

[sabsaxo]

But then I need ANOTHER module to get the AST from the code!? I would expect konan to return THAT based upon a file path I pass to it ... !?

[sabsaxo]

It's VERY confusing!

[sabsaxo]

Could you please provide an example where you simply pass in a file path as a string ... IF that's how I can use it!

[sabsaxo]

This code:

konan(`
	import React, {Component} from 'react'

	const vue = require('vue/dist/vue')

	import('./my-async-module').then()
	
	require(path.resolve('./'))
`)

simply doesn't make any sense.

[sabsaxo]

'detective' works like this:

var detective = require('detective');
var fs = require('fs');

var src = fs.readFileSync(__dirname + '/strings_src.js');
var requires = detective(src);
console.dir(requires);

And I can't see how that matches how 'konan' works ... ?

[egoist]

like I said, code or AST:

const code = `
console.log('js code')
`

konan(code)

//-------------- or hmm read the content from a script

const fs = require('fs')
const content = fs.readFileSync('./your/script', 'utf8')
konan(content)

//-------------- or if you already have an AST tree
konan(ast)

Does this make sense to you?

[sabsaxo]

Well, it only tell me that the module does NOT work like 'detective`.

And that's why I get errors when trying to do this:

const konan = require('konan');
let src = fs.readFileSync( path + '/index.js' ); // path is the path to the module folder.

let requires = konan( src );

console.log("Requires", requires, src);

[sabsaxo]

It keep throwing this at me:

Error: You must pass a scope and parentPath unless traversing a Program/File. Instead of that you tried to traverse a undefined node without passing scope and parentPath.

Please, provide complete example of what scope and parenPath is ...

[egoist]

There're edge cases when it says like but not same

The input must be a utf8 string not the buffer you're currently passing to konan

[sabsaxo]

I've done this as well, but still the same:

const detective = require('detective');
const konan = require('konan');
let src = fs.readFileSync( path + '/index.js', 'utf8');

let requires = konan( src );

console.log("Requires", requires, src);

[egoist]

https://github.com/egoist/konan/blob/master/test/index.test.js

it works for me

[limichange]

@sabsaxo I think you should make an example by codesandbox