gruntjs / gruntjs/grunt

grunt.util deprecated functions should be indicated in the tutorial

Open
#1,785 1 comment 0 reactions 0 assignees View on GitHub
Type: Question
Dominant language
JavaScript
Stars
12.2k
Forks
1.5k
PR merge metrics
No merged PRs in 30d

Description

Hi, I was looking at grunt.util.spawn today and I did find the way to use it here on the official website:
https://gruntjs.com/api/grunt.util#grunt.util.spawn
However, I got weird errors getting spawn to work (I was trying to execute some cmd).
After reading a bunch related topics on stackoverflow I finally ran into: https://github.com/gruntjs/grunt-legacy-util which says clearly in the doc that grunt.util.spawn is deprecated (along with some other grunt.util functions) and we should use node child_process instead.
Just think this should be mentioned in the official tutorial page otherwise it's misleading for users.

Thanks!

Contributor guide

Open the contributing guide

Research direction

Start with the official tutorial and the grunt.util API page linked in the issue, then compare their guidance with the grunt-legacy-util documentation. Update the tutorial so the deprecated grunt.util functions, including spawn, are identified and users are directed toward Node's child_process; done when the warning is clear and the documentation no longer misleading.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.