kwelch / babel-plugin-captains-log Goto Github PK
View Code? Open in Web Editor NEWBabel plugin that injects helpful details into console statements
License: MIT License
Babel plugin that injects helpful details into console statements
License: MIT License
I would like to add some docs to help those coming to the project.
Having not done this before I am not really sure how to structure it.
Open to other ideas, this is what I have seen commonly.
After upgrading webpack
, @babel/core
and babel-loader
to the latest version I catch this error. I can provide a repro if it's necessary, but I think it's easy to reproduce
Just installed it and it threw Module build failed: ReferenceError: Unknown plugin "captains-log" specified in "base" at 0, attempted to resolve relative to "/Users/mqklin/..."
My loader (from webpack.config.js
):
{
loader: 'babel-loader',
options: {
presets: [
['env', {targets: {browsers: ['last 2 versions', 'ie >= 10']}}],
'stage-2',
'react',
],
plugins: [
'babel-plugin-captains-log',
'transform-decorators-legacy',
'transform-react-jsx-self',
'transform-react-jsx-source',
'styled-components',
'transform-flow-strip-types',
],
},
},
I can create repro if it's necessary.
Seems like there might be some performance concerns with this plugin, as suggested by the Meteor team: meteor/meteor#9884 (comment)
The main reason I wrote this was for the inject variable names feature. The inject scope was the first feature, but is hacky at best.
To move toward a true release candidate,
These are changes based on current implementation. Please reply with any additional features or settings you would like to see added.
Currently the search is looking for member expressions where the object is console, this does not capture scenarios where console is alias or destructured.
const {warn} = console;
```
const c = console;
c.log();
```
It may be beneficial to capture these scenarios.
Here is a cut from my webpack config:
{
test: /\.js$/,
use: [
'react-hot-loader',
'cache-loader',
{
loader: 'babel-loader',
options: {
cacheDirectory: true,
presets: [
['env', {targets: {browsers: ['last 2 versions']}}],
'stage-2',
'react',
],
plugins: [
'transform-decorators-legacy',
'transform-react-jsx-self',
'transform-react-jsx-source',
'styled-components',
'captains-log',
],
},
},
'eslint-loader',
],
exclude: /node_modules/,
},
If I remove eslint-loader
, captains-log
works as expected.
I can create an example for reproduce the issue if necessary.
The file names appended to console statement include the entire path from root
/Users/welchk/_git/enga-web_new/packages/client/src/App/events/Views/Catalog/index.js(189:4) filters []
index.js(189:4) filters []
^^^^^^^^^ This would be a minimum fix
Ideally
It would recognize index and pull the parent folder as such:
Catalog/index.js(189:4) filters []
master
branch failed. π¨I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.
You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. Iβm sure you can resolve this πͺ.
Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.
Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master
branch. You can also manually restart the failed CI job that runs semantic-release.
If you are not sure how to resolve this, here is some links that can help you:
If those donβt help, or if this issue is reporting something you think isnβt right, you can always ask the humans behind semantic-release.
The npm token configured in the NPM_TOKEN
environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/
.
If you are using Two-Factor Authentication, make configure the auth-only
level is supported. semantic-release cannot publish with the default auth-and-writes
level.
Please make sure to set the NPM_TOKEN
environment variable in your CI with the exact value of the npm token.
Good luck with your project β¨
Your semantic-release bot π¦π
In my code this
console.log(checked);
turns into this
console.log('checked', 'checked', checked);
I think it should be just
console.log('checked', checked);
isn't it? Should I create a repro?
This looks like a great start! Thanks for creating this!
One more feature would convince me to use it ... pretending source file names.
Inspired by https://github.com/mattphillips/babel-plugin-console#macros
Honestly, don't know much about babel-macros but seems like a good option to have.
Update
After reading more into macros I like the accessibility and ease of use, but not sure it fits the intent of this project directly.
Going to leave this open a few days as I ponder.
If I put some options (eg ["captains-log", {"injectScope": false}],
) it stops work.
See this PR for example.
For some reason, this code doesn't work:
console.log(`%c ${123}`, 'color:red');
(it logs %c 123 color:red
)
But if I turn-off the plugin, it works as expected.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
π Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. πππ
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google β€οΈ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.