I'm trying to do a regex replace, but getting Warning: An error occurred while processing a template ($1 is not defined). Use --force to continue.

// .kit compiler
{
    pattern: /<!-- @import (.*?) -->/ig,
    replacement: '<%= grunt.file.read(yeoman.dist+$1) %>'
}

I've tried a few combos, do you know what I'm missing? Is this even possible with the current code?

I've noticed that when string Replace creates directories funny permission errors are created on Windows 8.1.

Running "string-replace:dist" (string-replace task)
Warning: EPERM: operation not permited, scandir 'c:\Users\...\projects\project\src/js'

Javascript doesn't support the regex negative lookbehind and seems there is not an easy work around , and this seems to be esencial ? any ideas on how to implement that in this plugin.

I guess I will need some how grunt call some task of python or php to support the lookbehind

Each of the tasks matches exactly one file, but the "files created" counter keeps increasing.

The output should have "1 file created" each time (and it does only create one file).

configuration sample:

'string-replace': {
    [moduleName]: {
        files: {
            [baseIntDir + moduleName + '/tsconfig.json']: moduleName + '/tsconfig.json'
        },
        options: {
            replacements: [
                {
                    pattern: /\"\.\./gi,
                    replacement: '"../../..'
                }
            ]
        }
    },
    [moduleName + "-package"]: {
        files: {
            [baseOutDir + moduleName + '/package.json']: moduleName + '/package.json'
        },
        options: {
            replacements: [
                {
                    pattern: /0\.0\.0-PLACEHOLDER/gi,
                    replacement: pkg.version
                }
            ]
        }
    }
}

I use this on node 4.x works:

    'string-replace': {
      'remove': {
        files: {
          'public/lib/css/': 'public/lib/css/*.css'
        },
        options: {
          replacements: [
            {
              pattern: /(\@font\-face[^\}]+})/gm,
              replacement: ''
            }
          ]
        }
      }
    },

but did not work properly on 5.x. it will create public/lib/css/public/lib/css/ ... path on folders ... do0uh !!!

this will work on node 5.x

'string-replace': {
  'remove': {
    files: {
      './': 'public/lib/css/*.css'
    },
    options: {
      replacements: [
        {
          pattern: /(\@font\-face[^\}]+})/gm,
          replacement: ''
        }
      ]
    }
  }
},

I have a grunt default task which calls multiple tasks, like creating a temporary directory and then in the same default task, I call the string-replace.
For example, grunt.registerTask('default', ['copy','string-replace']);
String replace doesn't throw any errors but doesn't replace anything.
If I call grunt string-replace after the task has ended, then it works as expected.
In short, the string-replace task doesn't work on the copied files from the copy task but after the grunt exits, then if I call grunt string-replace, then it replaces the values.

grunt-cli v0.1.6
grunt v0.4.1

no error, but can not generate the replaced file.

I installed version 1.3.0 and getting this error:

Verifying property string-replace.development exists in config...OK
Reading src/index.html...OK
Warning: An error occurred while processing a template (_.pluck is not a function). Use --force to continue

Lodash is on 4.16.1 and what I can see _pluck is removed from lodash

Can you please fix this issue?

It seems that the string pattern is only replacing the first occurrence of the matched string, rather than being a true pattern match and replace.

'string-replace' logged that it had 'created' all of the files in my specified directory, even though none of the files actually matched my replacement config.

In some of those files, this saving process over-wrote some characters in my files with some other character that's showing up in my text editor as �, despite my config for string-replace specifying a specific string to replace. The replaced characters included smart quotes and a copyright symbol. It is still showing up "correctly" in the browser, so maybe it's just different flavors of unicode or something? I'm not an expert on this topic.

Interestingly, svn revert isn't fixing this character difference, so whatever 'string-replace' did to the smart-quote, svn doesn't seem to know it's different for revert purposes, although it DOES know it's different for saying the file has been modified ( which it shouldn't have been in the first place ).

my config looked like this -

"string-replace": {
        velocity: {
            files: [{
                expand: true,
                cwd: "templates/velocity/",
                src: ['**/*.vm'],
                dest: 'templates/velocity/'
            }],
            options: {
                replacements: [{
                    pattern: "#set($template_version =",
                    replacement: '"#set($templateVersion ="'
                }]
            }
        }
    }

I would think that, ideally, grunt-string-replace would not save a file that it didn't think it was performing a replacement in. I saw it trigger my grunt-watch on my templates/velocity folder, and it seems like it would also not interact properly with grunt-newer.

It would be very helpful if this plugin would report something to the console when it runs and does replacement.

Two reasons for this:

1. All other plugins I've used do this, and it is helpful
2. For awhile, I thought no output from this plugin meant that it didn't match anything and that my config was not working correctly. Turns out it was fine and I was incorrectly assuming that based on no console output.

Regardless, thanks for providing this solution to my grunt scripts!

In your documentation you have two examples for wildcard file source/destination.

The folder wildcard does not copy the files where I would expect them to.

Here is my config:
'<%= dirs.build %>/rails/less/base/': '<%= dirs.build %>/less/base/*'

However, the files from build/less/base end up in build/rails/less/base/build/less/base instead of where I would expect them to: build/rails/less/base.

The multi-source option does not work at all.
'<%= dirs.build %>/rails/less/': '<%= dirs.build %>/less/**'

In that case I get:
Warning: Unable to read "build/less" file (Error code: EISDIR). Use --force to continue.

I understand that the new dependency upgrades in 1.3.2+ have pushed out the support for Node v6, etc.

I have a project that is (unfortunately) stuck on v6.2.0 and we use this module. We had our package.json set up with "grunt-string-replace": ^1.3.1 and the new update broke our build. We resolved this by removing the carrot and staying at 1.3.1.

We were expecting this module to conform to semantic versioning thus didn't expect a PATCH version update to cause a break in v6.2.0. In my opinion, your change should have been a major version update in order to not break projects still on old Node versions.

At first, thanks for your great job!

I feel confused when I setting the files directory with the examples, and I setting as follow:

prod: {
    files: {
        './production/html/': '*.html'
    },
    options: {
        replacements: [{
            pattern: '<link rel="stylesheet" href="../style.dev.css" >',
            replacement: '<link rel="stylesheet" href="../style.css" >'
        }]
    }
}

there are no error display, but no file change. So I find the question at stackoverflow and the answer witch selected help me to figure out this problem:

files: {
    './': 'production/html/*.html'
}

But I don't know why. So I hope you can give more examples or informations for people to avoid error.

Thanks again!

can you better explain what these are?

    files: {
      'path/to/directory/': 'path/to/source/*', // includes files in dir
      'path/to/directory/': 'path/to/source/**', // includes files in dir and subdirs
      'path/to/project-<%= pkg.version %>/': 'path/to/source/**', // variables in destination
      'path/to/directory/': ['path/to/sources/*.js', 'path/to/more/*.js'], // include JS files in two diff dirs
      'path/to/filename.ext': 'path/to/source.ext'
    },

what is destination and what is source?

I need to do something when matching failed? but I don't know how to do. whether it will trigger some events, I wish you can help me recently.

I'm using grunt-string-replace to modify some connection parameters in javascript depending on the deployment endpoint. I'd like grunt to error out if no matches were found because the application will fail if the replacement doesn't happen.

Thanks

This could be my newbness showing here, but I updated packages after the grunt 0.4 update and now I'm getting this.

Here's an example of the Gruntfile.js...

'string-replace': {
  test: {
    files: {
      'dist/index.html': ['dist/index.html']
    },
    options: {
      replacements: [{
        pattern: /\s*<script src=".*.dev.js"><\/script>/,
        replacement: ''
      },{
        pattern: /src="scripts/g,
        replacement: 'src="/scripts',
      }]
    }
  }
},

I looked through some examples of other Gruntfiles but I'm not seeing a solution to this error. Any ideas?

Hi guys,

I tested in node 5.7.0 and it didn't work properly. It created some directories instead of updating the files. I am going to find a good example to show you. Just a heads up for now.

When I run the following in Grunt with string-replace, I get an error which keeps the rest of my grunt tasks from firing.

dist: {
    files: {
        'dist/www/index.html': 'index.html'
    },
    options: {
        replacements: [
            {
                pattern: '<!-- templates (replaced with grunt) -->',
                replacement: grunt.file.read("dev/js/build/templates.html")
            }
        ]
    }
}

Produces the following error when ran:

Running "string-replace:dev" (string-replace) task
Warning: An error occurred while processing a template (Name is not defined).� Use --force to continue.

Aborted due to warnings.
Process finished with exit code 4

This may be a Grunt issue or me not understanding Grunt and may not fall into this specific plugin, but I don't have this issue with others. The strange part is that it seems to correctly replace that HTML comment with the contents of templates.html... the error just stops the rest of the task from being fired.

Hello @erickrdch!

I have a multiple instances (5) of a pattern in a file (app.yaml). When I run the grunt command, it only replaces the first instance of that pattern. Is there anything I am missing in the code?

Here's the code I have.

'string-replace' : {
            dist: {
                options: {
                    replacements: [
                        {
                            pattern: '@appName',
                            replacement: 'helloWorld'
                        }
                    ]
                },
                files: [
                    {
                        expand: true,
                        src: [
                          'app.yaml'
                        ]
                    }
                ]
            }
        }

Even when using regex (not string) as a pattern, only the first occurrence gets replaced...

Hi Erick , I ran into a problem with '<' and '>' characters in the replacement string. If the closing tag is not escaped (Ex 1) the task throws an error of:

Warning: An error occurred while processing a template (Unexpected string).

Example 1:

pattern: /:(\s*)url\((img)(.+?)\)/ig, replacement: ':$1url(\<%= asset_path \'$2$3\' %>)'

I tried escaping the last '>' as well, but no luck with this either.

pattern: /:(\s*)url\((img)(.+?)\)/ig, replacement: ':$1url(\<%= asset_path \'$2$3\' %\>)'

There was also one case where the last '%>' would just be ignored, but I can't reproduce it anymore. The only way I got this to work is to run 2 passes:

options: { replacements: [{ pattern: /:(\s*)url\((img)(.+?)\)/ig, replacement: ':$1url(\<%= asset_path \'$2$3\' CLOSE)' }, { pattern: /CLOSE/g, replacement: '%>' }] }

In the usage examples I found this, which might be the explanation why this doesn't work? Reserved characters for config?

files: { '<%= config.dist %>': '<%= config.src %>' }

Every time I try to run this task I get the following error:

Running "string-replace:predeploy" (string-replace) task
Warning: Unable to read "temp/assets/compiled" file (Error code: EISDIR). Use --force to continue.

Here's my configuration:

{
...
'string-replace': {
    predeploy: {
        files: {
            'temp/assets/': 'temp/assets/**/*'
        },
        options: {
            replacements: [{
                pattern: /\{\{assets\}\}/ig,
                replacement: S3_URL + deploy_time +'/'
            }]
        }
    }
}
}

When using:

config: {
    dist: 'dist/',
    prod: 'prod/'
}
files: {
      '<%= config.prod %>': '<%= config.dist %>*'
},

The result gives a folder structure of:

dist
--filename.html
prod
--dist
-----filename.html

Is there any way to prevent it from creating the source directory as a subdirectory to the destination folder?

Hi,

I have this working with single files, but not when targeting all files of a type in a directory.

Working:

files: {
    '<%= project.dev.html_prototypes %>/index.html': '<%= project.dev.html_prototypes %>/index.html',
}

Not working:

files: {
      '<%= project.build.styles %>/': '<%= project.build.styles %>/*.css',
}

In the second example, replacement occurs, but the path to the file is duplicated with the file, i.e. /path/to/foo becomes /path/to/foo/path/to/foo:

Reading wp-content/themes/myproject/resources/build/styles/at.css...OK
Writing wp-content/themes/myproject/resources/build/styles/wp-content/themes/myproject/resources/build/styles/at.css...OK

Is there something obvious that I'm missing here (such as a 'flatten' option)?

Thanks,
Dan

I'm trying to replace some references and append the package version at the same time. Is this supported? Using the the following options the references are changed but the version number is ignored.

options: {
          replacements: [{
            pattern     : 'modernizr-dev.js',
            replacement : "modernizr-custom.min.js?<%= pkg.version %>"
          },
          {
            pattern     : 'concat.css',
            replacement : "concat.min.css?<%= pkg.version %>"
          },
          {
            pattern     : 'site.js',
            replacement : "site.min.js?<%= pkg.version %>"
          },
          {
            pattern     : 'plugins.js',
            replacement : "plugins.min.js?<%= pkg.version %>"
          }]
        }

Het @erickrdch

Does this plugin work in the 0.4.0 environemnt yet? If not, any plans to move it that way?

Thanks!

Hello

A multiline pattern with the /m modifier is not working.

Thanks.

I'm posting this issue to let you know that we will be publishing Grunt 0.4 on Monday, February 18th.

If your plugin is not already Grunt 0.4 compatible, would you please consider updating it? For an overview of what's changed, please see our migration guide.

If you'd like to develop against the final version of Grunt before Monday, please specify "grunt": "0.4.0rc8" as a devDependency in your project. After Monday's release, you'll be able to use "grunt": "~0.4.0" to actually publish your plugin. If you depend on any plugins from the grunt-contrib series, please see our list of release candidates for compatible versions. All of these will be updated to final status when Grunt 0.4 is published.

Also, in an effort to reduce duplication of effort and fragmentation in the developer community, could you review the grunt-contrib series of plugins to see if any of your functionality overlaps significantly with them? Grunt-contrib is community maintained with 40+ contributors—we'd love to discuss any additions you'd like to make.

Finally, we're working on a new task format that doesn't depend on Grunt: it's called node-task. Once this is complete, there will be one more conversion, and then we'll never ask you to upgrade your plugins to support our changes again. Until that happens, thanks for bearing with us!

If you have any questions about how to proceed, please respond here, or join us in #grunt on irc.freenode.net.

Thanks, we really appreciate your work!

Replace strings on files by using string or regex patterNs.

Can a replacement function access the file-name/file-path of the file that is currently being processed?

E.g.

    replacements: [{
        pattern: /<img src=["']([^"']*?)["']/ig,
        replacement: function(match, p1, offset, wholeString) {
            var newPath = derivePathFrom(CURRENT_SOURCE_FILE);
            return '<img src="' + newPath + '/' + p1 + '"';
        }
    }]

If not, can this be added?

Hi.
It seems that 'files' doesn't support variables, ex

files: { path.join(x,y):path.join(z) }

var filepath = something, filepath2 = something2
...

files: {filepath: filepath2}

Would you please consider supporting them? thanks.