Giter Club home page Giter Club logo

func-loc's Introduction

func-loc

Coveralls Build Status Codacy Badge David David node npm npm GitHub issues GitHub top language GitHub contributors npm version vulnerabilities PRs Welcome MIT License

A simple tool that help you to retrieve the function location from its reference.

How to install

$ npm i func-loc

How to use

const { locate } = require('func-loc');

const fn = () => {
  console.log('Hello there');
};

(async () => {
  const result = await locate(fn);
  console.log(result);
  // Will result: { source: 'file://__BASE_FOLDER__/func-loc/this-file.js', line: 3, column: 12 }
})();

APIs

  1. locate(fn: Function): Will retrieve the location of a given function, and will cache it so that the second call will be faster.

The result of the call will be an object that contains these attributes:

  • source: The source file.
  • line: The line where the function was defined.
  • column: The exact column where the function was declared.

Internally, this function will open an inspector session. So it is always a good idea to call the disconnect method when you are done.

  1. disconnect() : will disconnect the inspector session, cleans the cache and delete temporary created objects from the global object.

Using Source Maps

This library can also locate the original code using source-map:

Lets say that you have a typescript file containing:

// File: `module.ts`
export function inner() {
  const fn3 = () => {};
  return fn3;
}

Transpiling this file using typescript compiler will generate a source map file like:

{
  "origin": {
    "path": "/BASE_FOLDER/module.js",
    "column": 24,
    "line": 5,
    "source": "file:///BASE_FOLDER/module.js"
  },
  "line": 3,
  "column": 14,
  "path": "/BASE_FOLDER/module.ts",
  "source": "file:///BASE_FOLDER/module.ts"
}

And a javascript file containing:

"use strict";
exports.__esModule = true;
// File: `module.ts`
function inner() {
    var fn3 = function () { };
    return fn3;
}
exports.inner = inner;
//# sourceMappingURL=module.js.map

If you execute the following code

const { locate } = require('func-loc');
const { inner } = require('../__tests__/assets/module');

(async () => {
  const loc = await locate(inner(), { sourceMap: true });
  console.log(loc);
})();

It will output the line of the inner function f3 of the file module.ts:

{
  "origin": {
    "path": "/BASE_FOLDER/module.js",
    "column": 24,
    "line": 5,
    "source": "file:///BASE_FOLDER/module.js"
  },
  "line": 3,
  "column": 14,
  "path": "/BASE_FOLDER/module.ts",
  "source": "file:///BASE_FOLDER/module.ts"
}

License

MIT © Mohamed IDRISSI

func-loc's People

Contributors

inpt-simo avatar jlaamanen avatar midrissi avatar tbiesemann avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

func-loc's Issues

ESLint errors on Windows

ESLint report CRLF end of line as errors.

In Windows, if git option core.autocrlf is set to true, all files will have CRLF eol after clone.

To fix this, you can clone with this command line:
git clone -c core.autocrlf=false https://github.com/midrissi/func-loc.git

Unit tests fail in Windows

On Windows, npm test fails with errors like:

image

What the paths returned by locate(fn) should look like in Windows ?

Windows 10 v1903
Node 10.16.3

Get wrong path on Windows

Node.js 12.21.0
func-loc 0.1.16

Running on: Windows 10 CMD

Files:

├── modules
│   └── xx.js
── test.js

xx.js:

exports.XX = class XX {}

test.js:

const XX = require('./modules/xx').XX;
const locate = require('func-loc').locate;

console.log(locate(func));

The actual result is:

{
  column: 14,
  line: 1,
  path: '/C:/Users/my/code/test/modules/xx.js',
  source: 'file:///C:/Users/my/code/test/modules/xx.js'
}

the path and source is not Windows path. The excepted path is:

C:\Users\my\code\test\modules\xx.js

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.